feat: folder support (#40)

* folder support

* improve naming

* fix tests

Author: denyskon

src/middlewares/localFs/index.spec.ts

@@ -99,9 +99,18 @@ describe('localFsMiddleware', () => {
   describe('getMedia', () => {
     it('should get media files', async () => {
       (listRepoFiles as jest.Mock).mockResolvedValue([
-        'mediaFolder/asset1.jpg',
-        'mediaFolder/asset2.jpg',
-        'mediaFolder/asset3.jpg',
+        { 
+          file: 'mediaFolder/asset1.jpg',
+          isDirectory: false
+        },
+        { 
+          file: 'mediaFolder/asset2.jpg',
+          isDirectory: false
+        },
+        { 
+          file: 'mediaFolder/asset3.jpg',
+          isDirectory: false
+        }
       ]);
 
       const json = jest.fn();
@@ -126,23 +135,35 @@ describe('localFsMiddleware', () => {
         {
           path: 'mediaFolder/asset1.jpg',
           url: 'mediaFolder/asset1.jpg',
+          isDirectory: false,
         },
         {
           path: 'mediaFolder/asset2.jpg',
           url: 'mediaFolder/asset2.jpg',
+          isDirectory: false,
         },
         {
           path: 'mediaFolder/asset3.jpg',
           url: 'mediaFolder/asset3.jpg',
+          isDirectory: false,
         },
       ]);
     });
 
     it('should translate media path to public path even when media path is absolute', async () => {
       (listRepoFiles as jest.Mock).mockResolvedValue([
-        'mediaFolder/asset1.jpg',
-        'mediaFolder/asset2.jpg',
-        'mediaFolder/asset3.jpg',
+        { 
+          file: 'mediaFolder/asset1.jpg',
+          isDirectory: false
+        },
+        { 
+          file: 'mediaFolder/asset2.jpg',
+          isDirectory: false
+        },
+        { 
+          file: 'mediaFolder/asset3.jpg',
+          isDirectory: false
+        }
       ]);
 
       const json = jest.fn();
@@ -168,23 +189,35 @@ describe('localFsMiddleware', () => {
         {
           path: 'mediaFolder/asset1.jpg',
           url: '/publicFolder/asset1.jpg',
+          isDirectory: false,
         },
         {
           path: 'mediaFolder/asset2.jpg',
           url: '/publicFolder/asset2.jpg',
+          isDirectory: false,
         },
         {
           path: 'mediaFolder/asset3.jpg',
           url: '/publicFolder/asset3.jpg',
+          isDirectory: false,
         },
       ]);
     });
 
     it('should translate media path to public path', async () => {
       (listRepoFiles as jest.Mock).mockResolvedValue([
-        'mediaFolder/asset1.jpg',
-        'mediaFolder/asset2.jpg',
-        'mediaFolder/asset3.jpg',
+        { 
+          file: 'mediaFolder/asset1.jpg',
+          isDirectory: false
+        },
+        { 
+          file: 'mediaFolder/asset2.jpg',
+          isDirectory: false
+        },
+        { 
+          file: 'mediaFolder/asset3.jpg',
+          isDirectory: false
+        }
       ]);
 
       const json = jest.fn();
@@ -210,14 +243,17 @@ describe('localFsMiddleware', () => {
         {
           path: 'mediaFolder/asset1.jpg',
           url: '/publicFolder/asset1.jpg',
+          isDirectory: false,
         },
         {
           path: 'mediaFolder/asset2.jpg',
           url: '/publicFolder/asset2.jpg',
+          isDirectory: false,
         },
         {
           path: 'mediaFolder/asset3.jpg',
           url: '/publicFolder/asset3.jpg',
+          isDirectory: false,
         },
       ]);
     });

src/middlewares/localFs/index.ts

@@ -41,10 +41,10 @@ export function localFsMiddleware({ repoPath, logger }: FsOptions) {
         case 'entriesByFolder': {
           const payload = body.params as EntriesByFolderParams;
           const { folder, extension, depth } = payload;
-          const entries = await listRepoFiles(repoPath, folder, extension, depth).then(files =>
+          const entries = await listRepoFiles(repoPath, folder, extension, depth).then(items =>
             entriesFromFiles(
               repoPath,
-              files.map(file => ({ path: file })),
+              items.map(item => ({ path: item.file })),
             ),
           );
           res.json(entries);
@@ -90,11 +90,12 @@ export function localFsMiddleware({ repoPath, logger }: FsOptions) {
         }
         case 'getMedia': {
           const { mediaFolder, publicFolder = mediaFolder } = body.params as GetMediaParams;
-          const files = await listRepoFiles(repoPath, mediaFolder, '', 1);
+          const fsItems = await listRepoFiles(repoPath, mediaFolder, '', 1);
           res.json(
-            files.map(file => ({
-              path: file.replace(/\\/g, '/'),
-              url: file.replace(/\\/g, '/').replace(mediaFolder.replace(/^\//g, ''), publicFolder),
+            fsItems.map(item => ({
+              path: item.file.replace(/\\/g, '/'),
+              url: item.file.replace(/\\/g, '/').replace(mediaFolder.replace(/^\//g, ''), publicFolder),
+              isDirectory: item.isDirectory,
             })),
           );
           break;

src/middlewares/types.ts

@@ -64,3 +64,8 @@ export type DeleteFilesParams = {
     commitMessage: string;
   };
 };
+
+export type FsItem = {
+  file: string;
+  isDirectory: boolean;
+};

src/middlewares/utils/fs.ts

@@ -1,7 +1,9 @@
 import path from 'path';
 import { promises as fs } from 'fs';
 
-async function listFiles(dir: string, extension: string, depth: number): Promise<string[]> {
+import type { FsItem } from '../types';
+
+async function listFiles(dir: string, extension: string, depth: number): Promise<FsItem[]> {
   if (depth <= 0) {
     return [];
   }
@@ -11,12 +13,10 @@ async function listFiles(dir: string, extension: string, depth: number): Promise
     const files = await Promise.all(
       dirents.map(dirent => {
         const res = path.join(dir, dirent.name);
-        return dirent.isDirectory()
-          ? listFiles(res, extension, depth - 1)
-          : [res].filter(f => f.endsWith(extension));
+        return {file: [res].filter(f => f.endsWith(extension))[0], isDirectory: dirent.isDirectory()} as FsItem;
       }),
     );
-    return ([] as string[]).concat(...files);
+    return ([] as FsItem[]).concat(...files);
   } catch (e) {
     return [];
   }
@@ -29,7 +29,7 @@ export async function listRepoFiles(
   depth: number,
 ) {
   const files = await listFiles(path.join(repoPath, folder), extension, depth);
-  return files.map(f => f.slice(repoPath.length + 1));
+  return files.map(f => {return {file: f.file.slice(repoPath.length + 1), isDirectory: f.isDirectory} as FsItem});
 }
 
 export async function writeFile(filePath: string, content: Buffer | string) {
@@ -54,7 +54,7 @@ export async function move(from: string, to: string) {
   const sourceDir = path.dirname(from);
   const destDir = path.dirname(to);
   const allFiles = await listFiles(sourceDir, '', 100);
-  await Promise.all(allFiles.map(file => moveFile(file, file.replace(sourceDir, destDir))));
+  await Promise.all(allFiles.map(item => moveFile(item.file, item.file.replace(sourceDir, destDir))));
 }
 
 export async function getUpdateDate(repoPath: string, filePath: string) {