Feature dynamic SDM folder paths (Issue #244)

README.md

@@ -18,6 +18,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - Link as attachments: Provides the capability to support link or URL as attachments.
 - Edit Link-type attachments: Provides the capability to update URL of link-type attachments.
 - Non-Draft Attachments: Provides the capability to work with attachments in non-draft (active) entities.
+- Dynamic SDM Folder Paths: Provides the capability to organize attachments in custom nested folder structures within the SDM repository.
 
 ### Table of Contents
 
@@ -28,6 +29,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - [Support for Link type attachments](#support-for-link-type-attachments)
 - [Support for Edit of Link type attachments](#support-for-edit-of-link-type-attachments)
 - [Support for Non-Draft Attachments](#support-for-non-draft-attachments)
+- [Support for Dynamic SDM Folder Paths](#support-for-dynamic-sdm-folder-paths)
 - [Support for Multitenancy](#support-for-multitenancy)
 - [Deploying and testing the application](#deploying-and-testing-the-application)
 - [Running the unit tests](#running-the-unit-tests)
@@ -630,6 +632,66 @@ service ProcessorService {
 }
 ```
 
+## Support for Dynamic SDM Folder Paths
+
+This plugin provides advanced folder management capabilities, allowing you to organize attachments in custom nested folder structures within the SDM repository. Instead of using the default entity-based folder structure, you can specify dynamic paths to organize attachments hierarchically based on your business logic.
+
+### Usage Examples
+
+#### 1. Basic Nested Folder Structure
+
+Organize attachments by project and document type:
+
+```javascript
+// Create attachment with custom path
+await POST('/Incidents(ID=<incident-id>)/attachments', {
+  filename: 'incident-report.pdf',
+  sdmPath: 'incidents/2024/reports'
+});
+```
+
+This creates the folder structure:
+```
+SDM Repository Root
+└── incidents/
+    └── 2024/
+        └── reports/
+            └── incident-report.pdf
+```
+
+#### 2. Dynamic Path Based on Business Data
+
+Generate paths dynamically based on entity properties:
+
+```javascript
+// In a custom handler
+srv.before('CREATE', 'Attachments', async (req) => {
+  const incident = await SELECT.one.from(Incidents, req.data.up__ID);
+
+  // Build path from incident properties
+  const year = new Date(incident.createdAt).getFullYear();
+  const priority = incident.priority || 'normal';
+
+  req.data.sdmPath = `incidents/${year}/${priority}/${incident.customer.name}`;
+});
+```
+
+Resulting structure:
+```
+incidents/
+├── 2024/
+│   ├── high/
+│   │   └── CustomerA/
+│   │       └── attachment.pdf
+│   └── normal/
+│       └── CustomerB/
+│           └── attachment.pdf
+└── 2025/
+    └── high/
+        └── CustomerC/
+            └── attachment.pdf
+```
+
 ## Support for Multitenancy
 
 This plugin automates repository lifecycle management in a multi-tenant setup. On tenant subscription, it provisions a repository and stores its details, and on unsubscription, it securely cleans up the repository.

index.cds

@@ -4,6 +4,7 @@ extend aspect Attachments with {
     repositoryId : String @title: 'Repository ID' @readonly default null;
     linkUrl: String @(title: '{i18n>LinkURL}') default null;
     type: String @(title: '{i18n>Type}') @(UI: {IsImageURL: true}) default 'sap-icon://document';
+    sdmPath: String default null;
 };
 annotate Attachments with @UI:{
   HeaderInfo: {
@@ -30,4 +31,5 @@ annotate Attachments with @UI:{
   mimeType @UI.Hidden;
   status @UI.Hidden;
   repositoryId @UI.Hidden;
+  sdmPath @UI.Hidden;
 }

lib/handler/index.js

@@ -109,6 +109,19 @@ async function getFolderIdByIDAsPath(req, credentials, destination, attachments)
   }
 }
 
+async function getFolderIdByDynamicPath(repositoryId, folderPath, credentials, destination) {
+  const getFolderURL = `${credentials.uri}browser/${repositoryId}/root/${folderPath}?cmisselector=object`;
+  try {
+    const response = await executeHttpRequest(destination, {
+      method: 'GET',
+      url: getFolderURL,
+    });
+    return response.data.properties["cmis:objectId"].value;
+  } catch {
+    return null;
+  }
+}
+
 async function createFolder(req, credentials, attachments, customFolderName, destination) {
   const upID = attachments.keys.up_.keys[0].$generatedFieldName;
   const { repositoryId } = getConfigurations();
@@ -138,6 +151,39 @@ async function createFolder(req, credentials, attachments, customFolderName, des
   return response
 }
 
+async function createNestedFolders(repositoryId, folderPath, credentials, destination) {
+  const pathSegments = folderPath.split('/').filter((segment) => segment);
+  let currentPath = '';
+  let parentId = null;
+  for (const segment of pathSegments) {
+    currentPath = currentPath ? `${currentPath}/${segment}` : segment;
+    const existingFolderId = await getFolderIdByDynamicPath(repositoryId, currentPath, credentials, destination);
+    if (existingFolderId) parentId = existingFolderId;
+    else {
+      const createURL = `${credentials.uri}browser/${repositoryId}/root`;
+      const formData = new FormData();
+      formData.append('cmisaction', 'createFolder');
+      if (parentId) formData.append('objectId', parentId);
+      formData.append('propertyId[0]', 'cmis:name');
+      formData.append('propertyValue[0]', segment);
+      formData.append('propertyId[1]', 'cmis:objectTypeId');
+      formData.append('propertyValue[1]', 'cmis:folder');
+      formData.append('succinct', 'true');
+      try {
+        const response = await executeHttpRequest(destination, { method: 'POST', url: createURL, data: formData });
+        parentId = response.data.succinctProperties['cmis:objectId'];
+      } catch (error) {
+        const retryFolderId = await getFolderIdByDynamicPath(repositoryId, currentPath, credentials, destination);
+        if (retryFolderId) parentId = retryFolderId;
+        else {
+          throw error;
+        }
+      }
+    }
+  }
+  return parentId;
+}
+
 async function createAttachment(
   data,
   credentials,
@@ -471,7 +517,9 @@ module.exports = {
   getRepositoryInfo,
   getFolderIdByPath,
   getFolderIdByIDAsPath,
+  getFolderIdByDynamicPath,
   createFolder,
+  createNestedFolders,
   createAttachment,
   editLink,
   deleteAttachmentsOfFolder,

lib/sdm.js

@@ -5,7 +5,9 @@ const {
   getRepositoryInfo,
   getFolderIdByPath,
   getFolderIdByIDAsPath,
+  getFolderIdByDynamicPath,
   createFolder,
+  createNestedFolders,
   createAttachment,
   editLink,
   deleteAttachmentsOfFolder,
@@ -558,8 +560,27 @@ let subdomain = cds.context?.user?.authInfo?.token?.payload?.ext_attr?.zdn;
 
   async getParentId(attachments, req, upId){
     const { repositoryId } = getConfigurations();
-    const folderIds = await getFolderIdForEntity(attachments, req, repositoryId, upId);
+    const destination = await this.getDestination(req);
+
+    let attachmentID = req.data?.ID;
+
+    if (req.event === 'UPDATE' || req.event === 'PUT') {
+       attachmentID = req.req.url.match(attachmentIDRegex)[1];
+    }
+
+    const metadata = await cds.ql.SELECT.one.from(req.target).where({ ID: attachmentID });
+    let folderPath = metadata?.sdmPath;
+
     let parentId = null;
+
+    if(!folderPath) folderPath = req.data?.sdmPath;
+
+    if (folderPath) { 
+      parentId = await getFolderIdByDynamicPath(repositoryId, folderPath, this.creds, destination);
+      return parentId ?? (await createNestedFolders(repositoryId, folderPath, this.creds, destination));
+    }
+
+    const folderIds = await getFolderIdForEntity(attachments, req, repositoryId, upId);
 
     for (const folder of folderIds) {
       if (folder.folderId !== null) {
@@ -1088,6 +1109,7 @@ let subdomain = cds.context?.user?.authInfo?.token?.payload?.ext_attr?.zdn;
         HasActiveEntity: false,
         linkUrl: req.data?.url,
         DraftAdministrativeData_DraftUUID: draftUUID[0].DraftAdministrativeData_DraftUUID,
+        sdmPath: req.data?.sdmPath
       };
       console.info(`[createLink] updating link in draft`, { updatedFields });