Save modules with names like ProjectName.ClassName.json.

Save modules with multi-line formatted json.

Removed moduleName field from Module (and Robot, Mechanism, and OpMode).
Removed userVisibleName from Project.

Renamed ModuleNameComponent.tsx to ClassNameComponent.tsx.

In Menu.tsx, added handleDownload and handleUpload. I didn't add the actual UI element (menu or button, etc) to trigger the handlers.

Author: lizlooney

src/blocks/mrc_mechanism.ts

@@ -186,9 +186,9 @@ const MECHANISM = {
         if (this.getFieldValue(FIELD_TYPE) !== foundMechanism.className) {
           this.setFieldValue(foundMechanism.className, FIELD_TYPE);
         }
-        // If the mechanism module name has changed, update this block.
-        if (this.mrcImportModule !== foundMechanism.moduleName) {
-          this.mrcImportModule = foundMechanism.moduleName;
+        const importModule = commonStorage.pascalCaseToSnakeCase(foundMechanism.className);
+        if (this.mrcImportModule !== importModule) {
+          this.mrcImportModule = importModule;
         }
         this.mrcParameters = [];
         components.forEach(component => {
@@ -245,12 +245,10 @@ export const pythonFromBlock = function (
 
 export function createMechanismBlock(
     mechanism: commonStorage.Mechanism, components: commonStorage.Component[]): toolboxItems.Block {
-  const lastDot = mechanism.className.lastIndexOf('.');
-  const mechanismName = (
-      'my_' +
-      commonStorage.pascalCaseToSnakeCase(mechanism.className.substring(lastDot + 1)));
+  const snakeCaseName = commonStorage.pascalCaseToSnakeCase(mechanism.className);
+  const mechanismName = 'my_' + snakeCaseName;
   const extraState: MechanismExtraState = {
-    importModule: mechanism.moduleName,
+    importModule: snakeCaseName,
     parameters: [],
   };
   const inputs: {[key: string]: any} = {};

src/blocks/utils/python.ts

@@ -268,6 +268,8 @@ export function getOutputCheck(type: string): string {
 // This is a legal name for python methods and variables. 
 export function getLegalName(proposedName: string, existingNames: string[]){
   let newName = proposedName.trim().replace(' ', '_');
+
+  // TODO: Allow the user to put numbers in the name.
 
   if (!/^[A-Za-z_]/.test(newName)){
       newName = "_" + newName;

src/reactComponents/AddTabDialog.tsx

@@ -24,7 +24,7 @@ import * as Antd from 'antd';
 import * as I18Next from 'react-i18next';
 import * as React from 'react';
 import * as commonStorage from '../storage/common_storage';
-import ModuleNameComponent from './ModuleNameComponent';
+import ClassNameComponent from './ClassNameComponent';
 
 /** Represents a module item in the dialog. */
 interface Module {
@@ -306,7 +306,7 @@ export default function AddTabDialog(props: AddTabDialogProps) {
             </Antd.Radio.Button>
           </Antd.Radio.Group>
 
-          <ModuleNameComponent
+          <ClassNameComponent
             tabType={tabType}
             newItemName={newItemName}
             setNewItemName={setNewItemName}

src/reactComponents/ModuleNameComponent.tsx renamed to src/reactComponents/ClassNameComponent.tsx

@@ -25,8 +25,8 @@ import * as I18Next from 'react-i18next';
 import * as React from 'react';
 import * as commonStorage from '../storage/common_storage';
 
-/** Props for the ModuleNameComponent. */
-interface ModuleNameComponentProps {
+/** Props for the ClassNameComponent. */
+interface ClassNameComponentProps {
   tabType: TabType;
   newItemName: string;
   setNewItemName: (name: string) => void;
@@ -46,10 +46,10 @@ const INPUT_WIDTH_FULL = '100%';
 const ERROR_ALERT_MARGIN_TOP = 8;
 
 /**
- * Component for entering and validating module names.
+ * Component for entering and validating class names.
  * Provides input validation, error display, and automatic capitalization.
  */
-export default function ModuleNameComponent(props: ModuleNameComponentProps): React.JSX.Element {
+export default function ClassNameComponent(props: ClassNameComponentProps): React.JSX.Element {
   const {t} = I18Next.useTranslation();
   const [alertErrorMessage, setAlertErrorMessage] = React.useState('');
   const [alertErrorVisible, setAlertErrorVisible] = React.useState(false);

src/reactComponents/FileManageModal.tsx

@@ -24,7 +24,7 @@ import * as I18Next from 'react-i18next';
 import * as React from 'react';
 import * as commonStorage from '../storage/common_storage';
 import {EditOutlined, DeleteOutlined, CopyOutlined} from '@ant-design/icons';
-import ModuleNameComponent from './ModuleNameComponent';
+import ClassNameComponent from './ClassNameComponent';
 
 /** Represents a module in the file management system. */
 interface Module {
@@ -347,7 +347,7 @@ export default function FileManageModal(props: FileManageModalProps) {
         cancelText={t('Cancel')}
       >
         {currentRecord && (
-          <ModuleNameComponent
+          <ClassNameComponent
             tabType={currentRecord.type}
             newItemName={name}
             setNewItemName={setName}
@@ -376,7 +376,7 @@ export default function FileManageModal(props: FileManageModalProps) {
         cancelText={t('Cancel')}
       >
         {currentRecord && (
-          <ModuleNameComponent
+          <ClassNameComponent
             tabType={currentRecord.type}
             newItemName={name}
             setNewItemName={setName}
@@ -409,7 +409,7 @@ export default function FileManageModal(props: FileManageModalProps) {
           borderRadius: '6px',
           padding: '12px',
         }}>
-          <ModuleNameComponent
+          <ClassNameComponent
             tabType={props.moduleType}
             newItemName={newItemName}
             setNewItemName={setNewItemName}

src/reactComponents/Header.tsx

@@ -78,7 +78,7 @@ export default function Header(props: HeaderProps): React.JSX.Element {
 
   /** Gets the project name or fallback text. */
   const getProjectName = (): string => {
-    return props.project?.userVisibleName || 'No Project Selected';
+    return props.project?.projectName || 'No Project Selected';
   };
 
   return (

src/reactComponents/Menu.tsx

@@ -322,6 +322,92 @@ export function Component(props: MenuProps): React.JSX.Element {
     }
   };
 
+  // TODO: Add menu or button or something for the download action.
+  /** Handles the download action to generate and download json files. */
+  const handleDownload = async (): Promise<void> => {
+    if (!props.project || !props.storage) {
+      return;
+    }
+
+    try {
+      const blobUrl = await props.storage.downloadProject(props.project.projectName);
+      const filename = props.project.projectName + commonStorage.UPLOAD_DOWNLOAD_FILE_EXTENSION;
+
+      // Create a temporary link to download the file
+      const link = document.createElement('a');
+      link.href = blobUrl;
+      link.download = filename;
+      document.body.appendChild(link);
+      link.click();
+      document.body.removeChild(link);
+
+      // Clean up the blob URL
+      URL.revokeObjectURL(blobUrl);
+    } catch (error) {
+      console.error('Failed to download project:', error);
+      props.setAlertErrorMessage(t('DOWNLOAD_FAILED') || 'Failed to download project');
+    }
+  }
+
+  // TODO: Add menu or button or something for the upload action.
+  /** Handles the upload action to upload a previously downloaded project. */
+  const handleUpload = (): Antd.UploadProps => {
+    if (!props.storage) {
+      return;
+    }
+
+    const uploadProps: Antd.UploadProps = {
+      accept: commonStorage.UPLOAD_DOWNLOAD_FILE_EXTENSION,
+      beforeUpload: (file) => {
+        const isBlocks = file.name.endsWith(commonStorage.UPLOAD_DOWNLOAD_FILE_EXTENSION)
+        if (!isBlocks) {
+          // TODO: i18n
+          props.setAlertErrorMessage(file.name + ' is not a blocks file');
+          setAlertErrorVisible(true);
+          return false;
+        }
+        return isBlocks || Antd.Upload.LIST_IGNORE;
+      },
+      onChange: (info) => {
+      },
+      customRequest: ({ file, onSuccess, onError }) => {
+        const reader = new FileReader();
+        reader.onload = (event) => {
+          const dataUrl = event.target.result;
+          const existingProjectNames: string[] = [];
+          projects.forEach(project => {
+            existingProjectNames.push(project.projectName);
+          });
+          const uploadProjectName = commonStorage.makeUploadProjectName(file.name, existingProjectNames);
+          if (props.storage) {
+            props.storage.uploadProject(
+                uploadProjectName, dataUrl,
+                (success: boolean, errorMessage: string) => {
+                  if (success) {
+                    // TODO: i18n
+                    onSuccess('Upload successful');
+                    // TODO: Select the project that was just uploaded.
+                  } else {
+                    onError(errorMessage);
+                    // TODO: i18n
+                    props.setAlertErrorMessage('Unable to upload the project');
+                  }
+                }
+            );
+          }
+        };
+        reader.onerror = (error) => {
+          onError(error);
+          // TODO: i18n
+          props.setAlertErrorMessage(t('UPLOAD_FAILED') || 'Failed to upload project');
+          setAlertErrorVisible(true);
+        };
+        reader.readAsDataURL(file);
+      },
+    };
+    return uploadProps;
+  };
+
   /** Handles closing the file management modal. */
   const handleFileModalClose = (): void => {
     console.log('Modal onCancel called');

src/reactComponents/ProjectManageModal.tsx

@@ -74,7 +74,7 @@ export default function ProjectManageModal(props: ProjectManageModalProps): Reac
     const projects = await storage.listProjects();
 
     // Sort projects alphabetically by name
-    projects.sort((a, b) => a.userVisibleName.localeCompare(b.userVisibleName));
+    projects.sort((a, b) => a.projectName.localeCompare(b.projectName));
     setAllProjects(projects);
 
     if (projects.length > 0 && props.noProjects) {
@@ -186,25 +186,25 @@ export default function ProjectManageModal(props: ProjectManageModalProps): Reac
   /** Opens the rename modal for a specific project. */
   const openRenameModal = (record: commonStorage.Project): void => {
     setCurrentRecord(record);
-    setName(record.userVisibleName);
+    setName(record.projectName);
     setRenameModalOpen(true);
   };
 
   /** Opens the copy modal for a specific project. */
   const openCopyModal = (record: commonStorage.Project): void => {
     setCurrentRecord(record);
-    setName(record.userVisibleName + COPY_SUFFIX);
+    setName(record.projectName + COPY_SUFFIX);
     setCopyModalOpen(true);
   };
 
   /** Gets the rename modal title. */
   const getRenameModalTitle = (): string => {
-    return `Rename Project: ${currentRecord ? currentRecord.userVisibleName : ''}`;
+    return `Rename Project: ${currentRecord ? currentRecord.projectName : ''}`;
   };
 
   /** Gets the copy modal title. */
   const getCopyModalTitle = (): string => {
-    return `Copy Project: ${currentRecord ? currentRecord.userVisibleName : ''}`;
+    return `Copy Project: ${currentRecord ? currentRecord.projectName : ''}`;
   };
 
   /** Creates the container style object. */
@@ -224,8 +224,8 @@ export default function ProjectManageModal(props: ProjectManageModalProps): Reac
   const columns: Antd.TableProps<commonStorage.Project>['columns'] = [
     {
       title: 'Name',
-      dataIndex: 'userVisibleName',
-      key: 'userVisibleName',
+      dataIndex: 'projectName',
+      key: 'projectName',
       ellipsis: {
         showTitle: false,
       },
@@ -268,7 +268,7 @@ export default function ProjectManageModal(props: ProjectManageModalProps): Reac
           {allProjects.length > 1 && (
             <Antd.Tooltip title={t('Delete')}>
               <Antd.Popconfirm
-                title={`Delete ${record.userVisibleName}?`}
+                title={`Delete ${record.projectName}?`}
                 description="This action cannot be undone."
                 onConfirm={() => handleDeleteProject(record)}
                 okText={t('Delete')}
@@ -385,7 +385,7 @@ export default function ProjectManageModal(props: ProjectManageModalProps): Reac
           <Antd.Table<commonStorage.Project>
             columns={columns}
             dataSource={allProjects}
-            rowKey="userVisibleName"
+            rowKey="projectName"
             size="small"
             pagination={allProjects.length > DEFAULT_PAGE_SIZE ? {
               pageSize: DEFAULT_PAGE_SIZE,

src/reactComponents/ProjectNameComponent.tsx

@@ -58,18 +58,18 @@ export default function ProjectNameComponent(props: ProjectNameComponentProps):
 
   /** Handles adding a new item with validation. */
   const handleAddNewItem = (): void => {
-    const newUserVisibleName = props.newItemName.trim();
-    if (!newUserVisibleName || !props.projects) {
+    const newProjectName = props.newItemName.trim();
+    if (!newProjectName || !props.projects) {
       return;
     }
 
-    if (!commonStorage.isValidClassName(newUserVisibleName)) {
-      showError(newUserVisibleName + INVALID_NAME_MESSAGE_SUFFIX);
+    if (!commonStorage.isValidClassName(newProjectName)) {
+      showError(newProjectName + INVALID_NAME_MESSAGE_SUFFIX);
       return;
     }
 
-    if (props.projects.some((project) => project.userVisibleName === newUserVisibleName)) {
-      showError(DUPLICATE_NAME_MESSAGE_PREFIX + newUserVisibleName + DUPLICATE_NAME_MESSAGE_SUFFIX);
+    if (props.projects.some((project) => project.projectName === newProjectName)) {
+      showError(DUPLICATE_NAME_MESSAGE_PREFIX + newProjectName + DUPLICATE_NAME_MESSAGE_SUFFIX);
       return;
     }
 

src/reactComponents/Tabs.tsx

@@ -30,7 +30,7 @@ import {
   CloseCircleOutlined,
 } from '@ant-design/icons';
 import AddTabDialog from './AddTabDialog';
-import ModuleNameComponent from './ModuleNameComponent';
+import ClassNameComponent from './ClassNameComponent';
 import { TabType, TabTypeUtils } from '../types/TabType';
 
 /** Represents a tab item in the tab bar. */
@@ -375,7 +375,7 @@ export function Component(props: TabsProps): React.JSX.Element {
         cancelText={t('Cancel')}
       >
         {currentTab && (
-          <ModuleNameComponent
+          <ClassNameComponent
             tabType={currentTab.type}
             newItemName={name}
             setNewItemName={setName}
@@ -405,7 +405,7 @@ export function Component(props: TabsProps): React.JSX.Element {
         cancelText={t('Cancel')}
       >
         {currentTab && (
-          <ModuleNameComponent
+          <ClassNameComponent
             tabType={currentTab.type}
             newItemName={name}
             setNewItemName={setName}