[WIP] MINOR: Naming templates

package.json

@@ -16,7 +16,7 @@
     "@bimdata/bcf-components": "6.7.8",
     "@bimdata/components": "1.10.3",
     "@bimdata/design-system": "2.4.4",
-    "@bimdata/typescript-fetch-api-client": "10.48.0",
+    "@bimdata/typescript-fetch-api-client": "10.48.1",
     "@bimdata/viewer": "2.20.2-beta.2",
     "@paddle/paddle-js": "^1.6.5",
     "async": "^3.2.6",

src/components/specific/files/all-files-table/AllFilesTable.vue

@@ -218,6 +218,7 @@
               @download="$emit('download', file)"
               @file-clicked="$emit('file-clicked', file)"
               @manage-access="$emit('manage-access', file)"
+              @manage-naming-rule="$emit('manage-naming-rule', file)"
               @open-tag-manager="$emit('open-tag-manager', file)"
               @open-versioning-manager="$emit('open-versioning-manager', file)"
               @open-visa-manager="$emit('open-visa-manager', file)"
@@ -288,6 +289,7 @@ export default {
     "file-clicked",
     "go-folders-view",
     "manage-access",
+    "manage-naming-rule",
     "open-tag-manager",
     "open-versioning-manager",
     "open-visa-manager",

src/components/specific/files/files-manager/FilesManager.vue

@@ -9,8 +9,10 @@
         :spaceSubInfo="spaceSubInfo"
         :importFromOtherProjectsActions="importFromOtherProjectsActions"
         :initialSearchText="searchText"
+        :refreshFiles="refreshFiles"
         @update:searchText="searchText = $event"
         @upload-files="uploadFiles"
+        @manage-naming-conflicts="openNamingConflictsModal"
       />
       <div class="files-manager__content">
         <transition name="slide-fade-left">
@@ -74,8 +76,9 @@
             :loadingFileIds="loadingFileIds"
             :selection="selection"
             :filesToUpload="filesToUpload"
-            :folder="currentFolder"
+            :folder="folderWithNamingPreview"
             :foldersToUpload="foldersToUpload"
+            :hasNamingConflict="hasNamingConflict"
             @back-parent-folder="backToParent"
             @create-model="createModelFromFile"
             @create-photosphere="createModelFromFile($event, MODEL_TYPE.PHOTOSPHERE)"
@@ -88,6 +91,7 @@
             @file-clicked="onFileSelected"
             @file-uploaded="$emit('file-uploaded')"
             @manage-access="openAccessManager"
+            @manage-naming-rule="openFolderNamingConstraintManager"
             @open-tag-manager="openTagManager"
             @open-versioning-manager="openVersioningManager"
             @open-visa-manager="openVisaManager"
@@ -111,6 +115,7 @@
             @file-clicked="onFileSelected"
             @go-folders-view="goFoldersView"
             @manage-access="openAccessManager"
+            @manage-naming-rule="openFolderNamingConstraintManager"
             @open-tag-manager="openTagManager"
             @open-versioning-manager="openVersioningManager"
             @open-visa-manager="openVisaManager"
@@ -205,12 +210,14 @@ import FileService from "../../../../services/FileService.js";
 import TagService from "../../../../services/TagService";
 import { useFiles } from "../../../../state/files.js";
 import { useModels } from "../../../../state/models.js";
+import { useNamingConstraints } from "../../../../state/naming-constraints.js";
 import { useProjects } from "../../../../state/projects.js";
 import { useSpaces } from "../../../../state/spaces.js";
 import { useVisa } from "../../../../state/visa.js";
 import { collectDescendants } from "../../../../utils/file-tree.js";
 import { isFolder } from "../../../../utils/file-structure.js";
 import { getFilesFromEvent } from "../../../../utils/files.js";
+import { matchName } from "../../../../utils/naming-constraint.js";
 import { isFullTotal } from "../../../../utils/spaces.js";
 import { fileUploadInput } from "../../../../utils/upload.js";
 
@@ -225,6 +232,8 @@ import FilesManagerOnboarding from "./files-manager-onboarding/FilesManagerOnboa
 import FileTree from "../file-tree/FileTree.vue";
 import FileTreePreviewModal from "../file-tree-preview-modal/FileTreePreviewModal.vue";
 import FolderAccessManager from "../folder-access-manager/FolderAccessManager.vue";
+import FolderNamingConstraintManager from "../naming-constraint/FolderNamingConstraintManager.vue";
+import NamingConflictModal from "../naming-constraint/NamingConflictModal.vue";
 import FoldersTable from "../folder-table/FoldersTable.vue";
 import SubscriptionModal from "../../subscriptions/subscription-modal/SubscriptionModal.vue";
 import TagsMain from "../../tags/tags-main/TagsMain.vue";
@@ -264,6 +273,10 @@ export default {
       type: Object,
       required: true,
     },
+    refreshFiles: {
+      type: Function,
+      required: true,
+    },
   },
   emits: ["file-uploaded", "file-updated", "model-created"],
   setup(props, { emit }) {
@@ -280,8 +293,14 @@ export default {
     const { createModel, createPhotosphere, deleteModels } = useModels();
 
     const { fetchToValidateVisas, fetchCreatedVisas } = useVisa();
-
+    const { getEffectiveFolderRule } = useNamingConstraints();
     const currentFolder = ref(null);
+    const currentFolderNamingRule = ref(null);
+    const folderWithNamingPreview = computed(() =>
+      currentFolder.value
+        ? { ...currentFolder.value, namingConstraintPreview: currentFolderNamingRule.value }
+        : currentFolder.value,
+    );
     const currentFiles = ref([]);
     const toValidateVisas = ref([]);
     const createdVisas = ref([]);
@@ -337,20 +356,53 @@ export default {
 
     const filesToUpload = ref([]);
     const foldersToUpload = ref([]);
-    const uploadFiles = async (event, folder = currentFolder.value) => {
-      const { files, folders } = await getFilesFromEvent(event);
+    const proceedUpload = async ({ files, folders }, folder) => {
       files.forEach((file) => (file.folder = folder));
-
       filesToUpload.value = files;
       foldersToUpload.value = await Promise.all(
         folders.map((f) => FileService.createFolderStructure(props.project, folder, f)),
       );
-
       setTimeout(() => {
         filesToUpload.value = [];
         foldersToUpload.value = [];
       }, 10);
     };
+    let folders = [];
+    const uploadFiles = async (event, folder = currentFolder.value) => {
+      const { files, folders } = await getFilesFromEvent(event);
+
+      const rule = await getEffectiveFolderRule(props.project, folder);
+      const invalidFiles = rule ? files.filter((file) => !matchName(file.name, rule)) : [];
+
+      if (invalidFiles.length > 0) {
+        openModal({
+          component: NamingConflictModal,
+          props: {
+            project: props.project,
+            documents: invalidFiles.map((file, i) => ({ id: `upload-${i}`, name: file.name })),
+            rule,
+            persistChanges: false,
+            onClose: closeModal,
+            onConfirm: ({ renamed, deleted }) => {
+              const deletedIds = new Set(deleted.map((d) => d.id));
+              const renamedById = new Map(renamed.map((r) => [r.id, r.name]));
+              const finalFiles = invalidFiles
+                .map((file, i) => ({ file, id: `upload-${i}` }))
+                .filter(({ id }) => !deletedIds.has(id))
+                .map(({ file, id }) => {
+                  const name = renamedById.get(id);
+                  return name ? new File([file], name, { type: file.type }) : file;
+                });
+              const validFiles = files.filter((file) => matchName(file.name, rule));
+              proceedUpload({ files: [...validFiles, ...finalFiles], folders }, folder);
+            },
+          },
+        });
+        return;
+      }
+
+      proceedUpload({ files, folders }, folder);
+    };
 
     const loadingFileIds = ref([]);
     const isCreatingModels = ref(false);
@@ -544,6 +596,50 @@ export default {
       }, 100);
     };
 
+    const openFolderNamingConstraintManager = (folder) => {
+      openSidePanel("right", {
+        component: FolderNamingConstraintManager,
+        props: {
+          project: props.project,
+          folder,
+          refreshFiles: props.refreshFiles,
+        },
+      });
+    };
+
+    const openNamingConflictsModal = async () => {
+      const conflicting = allFiles.value.filter((file) => file.naming_constraint_conflict);
+      if (conflicting.length === 0) {
+        pushNotification({
+          type: "success",
+          title: t("NamingConstraint.noConflictsTitle"),
+          message: t("NamingConstraint.noConflictsMessage"),
+        });
+        return;
+      }
+      const documents = await Promise.all(
+        conflicting.map(async (file) => {
+          const folder = allFolders.value.find((f) => f.id === file.parent_id);
+          const effective = folder ? await getEffectiveFolderRule(props.project, folder) : null;
+          return { ...file, namingRule: effective };
+        }),
+      );
+      openModal({
+        component: NamingConflictModal,
+        props: {
+          project: props.project,
+          documents,
+          allFolders: allFolders.value,
+          rule: null,
+          showRulesByGroup: true,
+          onClose: closeModal,
+          onConfirm: async () => {
+            await props.refreshFiles();
+          },
+        },
+      });
+    };
+
     const visasLoading = ref(false);
     const openVisaManager = (file) => {
       onTabChange(filesTabs[2]);
@@ -683,6 +779,19 @@ export default {
     const allFiles = computed(() => getFilesInFolder(props.fileStructure));
     const allFolders = computed(() => getFoldersInFolder(props.fileStructure));
 
+    const hasNamingConflict = (folder) => {
+      if (!folder?.children?.length) {
+        return false;
+      }
+
+      return folder.children.some((child) => {
+        if (isFolder(child)) {
+          return hasNamingConflict(child);
+        }
+        return child.naming_constraint_conflict;
+      });
+    };
+
     const filesTabs = [
       {
         id: "folders",
@@ -758,11 +867,15 @@ export default {
     watch(
       () => props.fileStructure,
       (struct) => {
-        const folderId = gedTargetFolder.get();
+        const currentFolderId = currentFolder.value?.id;
+
+        if (currentFolderId) {
+          const folder = handler.get({
+            nature: FILE_TYPE.FOLDER,
+            id: currentFolderId,
+          });
 
-        if (folderId) {
-          jumpToTargetFolder(folderId);
-          gedTargetFolder.clear();
+          currentFolder.value = folder ? handler.deserialize(folder) : struct;
         } else {
           currentFolder.value = struct;
         }
@@ -772,11 +885,15 @@ export default {
 
     watch(
       () => currentFolder.value,
-      (folder) => {
+      async (folder) => {
+        if (!folder) return;
+
         const childrenFolders = folder.children.filter(isFolder).sort(sortByName);
         const childrenFiles = folder.children.filter((c) => !isFolder(c)).sort(sortByName);
+
         currentFiles.value = childrenFolders.concat(childrenFiles);
         gedTargetFolder.set(folder.id);
+        currentFolderNamingRule.value = await getEffectiveFolderRule(props.project, folder);
       },
       { immediate: true },
     );
@@ -788,6 +905,7 @@ export default {
       allTags,
       allVisas,
       currentFolder,
+      folderWithNamingPreview,
       currentSpace,
       currentVisa,
       displayedFiles,
@@ -829,10 +947,13 @@ export default {
       fileUploadInput,
       goFoldersView,
       goVisasView,
+      hasNamingConflict,
       isFullTotal,
       moveFiles,
       onFileSelected,
       openAccessManager,
+      openFolderNamingConstraintManager,
+      openNamingConflictsModal,
       openFileDeleteModal,
       openVisaDeleteModal,
       openSidePanel,