BKNDLSS-29862 JS API to create a directory (#234)

Author: stanislaw-grin

backendless.d.ts

@@ -809,6 +809,8 @@ declare module Backendless {
 
         function exists(path: string): Promise<Object>;
 
+        function createDirectory(path: string): Promise<void>;
+
         function removeDirectory(path: string): Promise<number>;
     }
 

src/files/index.js

@@ -279,18 +279,6 @@ export default class Files {
     })
   }
 
-  async removeDirectory(directoryPath) {
-    if (!directoryPath || typeof directoryPath !== 'string') {
-      throw new Error('Directory "path" must be provided and must be a string.')
-    }
-
-    directoryPath = FilesUtils.trimSlashesInPath(directoryPath)
-
-    return this.app.request.delete({
-      url: this.app.urls.filePath(directoryPath),
-    })
-  }
-
   async getFileCount(filesPath, pattern, sub, countDirectories) {
     if (!filesPath || typeof filesPath !== 'string') {
       throw new Error('"filesPath" must be provided and must be a string.')
@@ -313,5 +301,28 @@ export default class Files {
     })
   }
 
+  async createDirectory(directoryPath) {
+    if (!directoryPath || typeof directoryPath !== 'string') {
+      throw new Error('Directory "path" must be provided and must be a string.')
+    }
+
+    directoryPath = FilesUtils.trimSlashesInPath(directoryPath)
+
+    return this.app.request.post({
+      url: this.app.urls.directoryPath(directoryPath)
+    })
+  }
+
+  async removeDirectory(directoryPath) {
+    if (!directoryPath || typeof directoryPath !== 'string') {
+      throw new Error('Directory "path" must be provided and must be a string.')
+    }
+
+    directoryPath = FilesUtils.trimSlashesInPath(directoryPath)
+
+    return this.app.request.delete({
+      url: this.app.urls.filePath(directoryPath),
+    })
+  }
 }
 

src/urls.js

@@ -247,6 +247,10 @@ export default class Urls {
     return `${this.files()}/${path}`
   }
 
+  directoryPath(path) {
+    return `${this.files()}/${path}/`
+  }
+
   fileCopy() {
     return `${this.files()}/copy`
   }

test/tsd.ts

@@ -1573,6 +1573,7 @@ async function testFilesService() {
     let promiseObject: Promise<object>;
     let promiseBoolean: Promise<boolean>;
     let promiseNumber: Promise<number>;
+    let promiseVoid: Promise<void>;
 
     interface IFileUploadResult {
         fileURL: string
@@ -1643,6 +1644,7 @@ async function testFilesService() {
 
     promiseObject = Backendless.Files.exists(path);
 
+    promiseVoid = Backendless.Files.createDirectory(path);
     promiseNumber = Backendless.Files.removeDirectory(path);
 
     promiseBoolean = Backendless.Files.Permissions.READ.grantUser(userid, url);

test/unit/specs/files/basic.js

@@ -679,6 +679,50 @@ describe('<Files> Basic', function() {
 
   })
 
+  describe('Create Directory', () => {
+    it('creates a directory by a relative path', async () => {
+      const req1 = prepareMockRequest()
+      const req2 = prepareMockRequest()
+
+      const result1 = await Backendless.Files.createDirectory(dirPath)
+      const result2 = await Backendless.Files.createDirectory(filePathWithSlash)
+
+      expect(req1).to.deep.include({
+        method : 'POST',
+        path   : `${APP_PATH}/files/test/path/`,
+        headers: {},
+        body   : undefined
+      })
+
+      expect(req2).to.deep.include({
+        method : 'POST',
+        path   : `${APP_PATH}/files/test/path/`,
+        headers: {},
+        body   : undefined
+      })
+
+      expect(result1).to.be.eql(undefined)
+      expect(result2).to.be.eql(undefined)
+    })
+
+    it('fails when directoryPath is invalid', async () => {
+      const errorMsg = 'Directory "path" must be provided and must be a string.'
+
+      await expect(Backendless.Files.createDirectory()).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Files.createDirectory(undefined)).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Files.createDirectory(null)).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Files.createDirectory(true)).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Files.createDirectory(false)).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Files.createDirectory(0)).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Files.createDirectory(123)).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Files.createDirectory('')).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Files.createDirectory({})).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Files.createDirectory([])).to.eventually.be.rejectedWith(errorMsg)
+      await expect(Backendless.Files.createDirectory(() => ({}))).to.eventually.be.rejectedWith(errorMsg)
+    })
+
+  })
+
   describe('Remove Directory', () => {
     it('removes a directory by a relative path', async () => {
       const req1 = prepareMockRequest({ resultFileURL })