@mablhq/mabl-cli 1.47.20 → 1.48.0

package/api/mablApiClient.js

@@ -461,6 +461,26 @@ class MablApiClient extends basicApiClient_1.BasicApiClient {
             throw toApiError(`Failed to get File Upload URL`, error);
         }
     }
+    async getDatatables(workspaceId, limit) {
+        try {
+            const datatablesQueryString = queryString.stringify({
+                organization_id: workspaceId,
+                limit,
+            });
+            return await this.makeGetRequest(`${this.baseApiUrl}/variables/tables?${datatablesQueryString}`).then((result) => { var _a; return (_a = result.variableTables) !== null && _a !== void 0 ? _a : []; });
+        }
+        catch (error) {
+            throw toApiError(`Failed to retrieve datatables`, error);
+        }
+    }
+    async getDatatable(datatableId) {
+        try {
+            return await this.makeGetRequest(`${this.baseApiUrl}/variables/tables/${datatableId}`);
+        }
+        catch (error) {
+            throw toApiError(`Failed to get datatable`, error);
+        }
+    }
     async getDatatableRows(datatableId) {
         try {
             return await this.makeGetRequest(`${this.baseApiUrl}/variables/tables/${datatableId}/rows`).then((result) => { var _a; return (_a = result.variableRows) !== null && _a !== void 0 ? _a : []; });

package/cli.js

@@ -38,6 +38,7 @@ yargs
     .commandDir('./commands/branches')
     .commandDir('./commands/config')
     .commandDir('./commands/credentials')
+    .commandDir('./commands/datatables')
     .commandDir('./commands/deploy')
     .commandDir('./commands/environments')
     .commandDir('./commands/flows')

package/commands/commandUtil/list.js

@@ -1,8 +1,15 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getListBuilderOptions = void 0;
+exports.outputEntities = exports.getListBuilderOptions = void 0;
 const interfaces_1 = require("./interfaces");
 const constants_1 = require("../constants");
+const loggingProvider_1 = require("../../providers/logging/loggingProvider");
+const js_yaml_1 = require("js-yaml");
+const cli_table3_1 = __importDefault(require("cli-table3"));
+const moment = require("moment");
 function getListBuilderOptions(pluralEntityName) {
     return (yargs) => {
         yargs
@@ -28,3 +35,36 @@ function getListBuilderOptions(pluralEntityName) {
     };
 }
 exports.getListBuilderOptions = getListBuilderOptions;
+function outputEntities(entities, outputMode) {
+    loggingProvider_1.logger.logNewLine();
+    let content;
+    switch (outputMode) {
+        case constants_1.OutputFormats.Json:
+            content = JSON.stringify(entities, null, 2);
+            break;
+        case constants_1.OutputFormats.Yaml:
+            content = (0, js_yaml_1.dump)(entities);
+            break;
+        default:
+            const table = new cli_table3_1.default({
+                head: ['ID', 'Name', 'Created time'],
+                wordWrap: true,
+            });
+            entities.forEach((entity) => {
+                table.push([
+                    { rowSpan: 1, content: entity.id, vAlign: 'center' },
+                    { rowSpan: 1, content: entity.name, vAlign: 'center' },
+                    {
+                        rowSpan: 1,
+                        content: moment.utc(entity.created_time).format(constants_1.ListTimeFormat),
+                        vAlign: 'center',
+                    },
+                ]);
+            });
+            content = table.toString();
+            break;
+    }
+    loggingProvider_1.logger.info(content);
+    return content;
+}
+exports.outputEntities = outputEntities;

package/commands/datatables/datatables.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = 'datatables <command>';
+exports.describe = 'Manage mabl datatables';
+exports.builder = (yargs) => yargs.commandDir('datatables_cmds').demandCommand();

package/commands/datatables/datatables_cmds/describe.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const constants_1 = require("../../constants");
+const util_1 = require("../../commandUtil/util");
+const describe_1 = require("../../commandUtil/describe");
+exports.command = `describe <${constants_1.CommandArgId}>`;
+exports.describe = 'Describe a specific mabl datatable';
+exports.builder = (0, describe_1.getDescribeBuilderOptions)();
+exports.handler = (0, util_1.failWrapper)(getDatatable);
+async function getDatatable(parsed) {
+    const output = parsed.output;
+    const datatableId = parsed.id;
+    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    const datatable = await apiClient.getDatatable(datatableId);
+    (0, describe_1.outputEntity)(datatable, output);
+}

package/commands/datatables/datatables_cmds/export.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dumpToCsv = void 0;
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const util_1 = require("../../commandUtil/util");
+const constants_1 = require("../../constants");
+const fileUtil_1 = require("../../commandUtil/fileUtil");
+const js_yaml_1 = require("js-yaml");
+const csvUtil_1 = require("../../../util/csvUtil");
+const sync_1 = require("csv-stringify/sync");
+const SCENARIO_NAME_HEADER = 'Scenario name';
+exports.command = `export <${constants_1.CommandArgId}>`;
+exports.describe = 'Export a mabl test in a specified file format';
+exports.builder = (yargs) => {
+    yargs
+        .positional(constants_1.CommandArgId, {
+        describe: 'Datatable id to export',
+        type: 'string',
+    })
+        .option(constants_1.CommandArgFormat, {
+        alias: 'fmt',
+        default: constants_1.OutputFormats.Yaml,
+        describe: `Specify a format for the datatable export`,
+        choices: [constants_1.OutputFormats.Json, constants_1.OutputFormats.Yaml, constants_1.OutputFormats.Csv],
+    });
+};
+exports.handler = (0, util_1.failWrapper)(exportDatatable);
+async function exportDatatable(parsed) {
+    const datatableId = parsed.id;
+    const format = parsed.format;
+    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    const datatableRows = await apiClient.getDatatableRows(datatableId);
+    let output = '';
+    switch (format) {
+        case constants_1.OutputFormats.Json:
+            output = dumpToJson(datatableRows);
+            break;
+        case constants_1.OutputFormats.Yaml:
+            output = dumpToYaml(datatableRows);
+            break;
+        case constants_1.OutputFormats.Csv:
+            output = dumpToCsv(datatableRows);
+            break;
+    }
+    (0, fileUtil_1.writeExportedEntityToFile)(output, format, datatableId);
+}
+function stripDatatableRows(datatableRows) {
+    return datatableRows.map((variableRow) => ({
+        scenario: variableRow.scenario_id,
+        columns: variableRow.row,
+    }));
+}
+function dumpToJson(datatableRows) {
+    return JSON.stringify(stripDatatableRows(datatableRows), null, 2);
+}
+function dumpToYaml(datatableRows) {
+    return (0, js_yaml_1.dump)(stripDatatableRows(datatableRows));
+}
+function dumpToCsv(datatableRows) {
+    const output = [];
+    if (datatableRows.length === 0) {
+        return '';
+    }
+    const headers = [
+        SCENARIO_NAME_HEADER,
+        ...(datatableRows[0].row || []).map((variable) => (0, csvUtil_1.sanitizeCellInput)(variable.name || '')),
+    ];
+    output.push(headers);
+    datatableRows.forEach(({ scenario_id = '', row = [] }) => {
+        const sanitizedRowValues = [
+            scenario_id,
+            ...row.map((variable) => variable.value || ''),
+        ].map(csvUtil_1.sanitizeCellInput);
+        output.push(sanitizedRowValues);
+    });
+    return (0, sync_1.stringify)(output);
+}
+exports.dumpToCsv = dumpToCsv;

package/commands/datatables/datatables_cmds/list.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const util_1 = require("../../commandUtil/util");
+const list_1 = require("../../commandUtil/list");
+exports.command = 'list';
+exports.describe = 'List your datatables';
+exports.builder = (0, list_1.getListBuilderOptions)('datatables');
+exports.handler = (0, util_1.failWrapper)(listDatatables);
+async function listDatatables(parsed) {
+    const output = parsed.output;
+    const limit = parsed.limit;
+    const workspaceId = await (0, util_1.getWorkspaceId)(parsed);
+    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    const datatables = await apiClient.getDatatables(workspaceId, limit);
+    (0, list_1.outputEntities)(datatables, output);
+    return datatables.length;
+}