Add the Create Table API to JS-SDK (#237)

* BKNDLSS-31675 - Add the Create Table API to JS-SDK

Author: viktor-liablin

backendless.d.ts

@@ -724,6 +724,23 @@ declare module Backendless {
         function pushWithTemplate(templateName: string, templateValues?: object): Promise<Object>;
     }
 
+    /**
+     * @public
+     * @namespace Backendless.Management
+     **/
+    namespace Management {
+
+        /**
+         * @public
+         * @interface Backendless.Management.Data
+         */
+        interface Data {
+            createTable(name: string, columns: Array<object>): Promise<void>;
+        }
+
+        const Data: Data
+    }
+
     /**
      * @public
      * @namespace Backendless.Files

src/index.js

@@ -82,6 +82,7 @@ const SERVICES = {
   'SharedObject': () => require('./rso').default,
   'LocalCache'  : () => require('./local-cache').default,
   'UnitOfWork'  : () => require('./unit-of-work').default,
+  'Management'  : () => require('./management').default,
 }
 
 class Backendless {
@@ -416,6 +417,10 @@ class Backendless {
     return this.__getService('UnitOfWork')
   }
 
+  get Management() {
+    return this.__getService('Management')
+  }
+
   ///-------------- SERVICES -------------///
   ///-------------------------------------///
 

src/management/data.js

@@ -0,0 +1,21 @@
+export default class Data {
+  constructor(app) {
+    this.app = app
+  }
+
+  createTable(name, columns) {
+    if (!name || typeof name !== 'string') {
+      throw new Error('Table name must be provided and must be a string.')
+    }
+
+    if (!Array.isArray(columns)) {
+      throw new Error('Columns must be a list.')
+    }
+
+    return this.app.request
+      .post({
+        url : this.app.urls.managementDataTable(),
+        data: { name, columns },
+      })
+  }
+}

src/management/index.js

@@ -0,0 +1,9 @@
+import Data from './data'
+
+export default class Management {
+  constructor(app) {
+    this.app = app
+
+    this.Data = new Data(app)
+  }
+}

src/urls.js

@@ -367,4 +367,17 @@ export default class Urls {
   userStatus(userId) {
     return `${this.userObject(userId)}/status`
   }
+
+  //management
+  management() {
+    return `${this.root()}/management`
+  }
+
+  managementData() {
+    return `${this.management()}/data`
+  }
+
+  managementDataTable() {
+    return `${this.managementData()}/table`
+  }
 }

test/tsd.ts

@@ -1909,6 +1909,15 @@ function testLogging() {
     logger.trace(message);
 }
 
+function testManagementData() {
+    const str: string = 'str';
+    const arr: any[] = [];
+
+    let promiseVoid: Promise<void>;
+
+    promiseVoid = Backendless.Management.Data.createTable(str, arr);
+}
+
 ////// ------ RT ------- ///////
 
 function RTClient() {

test/unit/specs/management/data.js

@@ -0,0 +1,52 @@
+import { expect } from 'chai'
+import { describe, it } from 'mocha'
+
+import Backendless, { APP_PATH, forTest, prepareMockRequest } from '../../helpers/sandbox'
+
+describe('Management - Data', function() {
+  forTest(this)
+
+  const fakeResult = { foo: true }
+
+  describe('Create Table', function() {
+    it('success', async () => {
+      const request = prepareMockRequest(fakeResult)
+
+      await Backendless.Management.Data.createTable('MyTable', [])
+
+      expect(request).to.deep.include({
+        method: 'POST',
+        path  : `${APP_PATH}/management/data/table`,
+        body  : { name: 'MyTable', columns: [] }
+      })
+    })
+
+    it('fail when name is not provided or not a string', async () => {
+      const errorMsg = 'Table name must be provided and must be a string.'
+
+      await expect(() => Backendless.Management.Data.createTable(undefined, [])).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable(null, [])).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable(false, [])).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable(true, [])).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable([], [])).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable(0, [])).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable('', [])).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable(123, [])).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable(() => undefined, [])).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable({}, [])).to.throw(errorMsg)
+    })
+
+    it('fail when columns is not provided or not an array', async () => {
+      const errorMsg = 'Columns must be a list.'
+
+      await expect(() => Backendless.Management.Data.createTable('MyTable', undefined)).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable('MyTable', null)).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable('MyTable', false)).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable('MyTable', true)).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable('MyTable', 0)).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable('MyTable', 123)).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable('MyTable', () => undefined)).to.throw(errorMsg)
+      await expect(() => Backendless.Management.Data.createTable('MyTable', {})).to.throw(errorMsg)
+    })
+  })
+})