@budibase/server 1.0.78 → 1.0.79-alpha.10

package/dist/api/routes/table.js

@@ -4,22 +4,8 @@ const tableController = require("../controllers/table");
 const authorized = require("../../middleware/authorized");
 const { paramResource, bodyResource } = require("../../middleware/resourceId");
 const { BUILDER, PermissionLevels, PermissionTypes, } = require("@budibase/backend-core/permissions");
-const joiValidator = require("../../middleware/joi-validator");
-const Joi = require("joi");
+const { tableValidator } = require("./utils/validators");
 const router = Router();
-function generateSaveValidator() {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        _id: Joi.string(),
-        _rev: Joi.string(),
-        type: Joi.string().valid("table", "internal", "external"),
-        primaryDisplay: Joi.string(),
-        schema: Joi.object().required(),
-        name: Joi.string().required(),
-        views: Joi.object(),
-        dataImport: Joi.object(),
-    }).unknown(true));
-}
 router
     /**
      * @api {get} /api/tables Fetch all tables
@@ -46,7 +32,7 @@ router
      *
      * @apiSuccess {object[]} body The response body will be the table that was found.
      */
-    .get("/api/tables/:id", paramResource("id"), authorized(PermissionTypes.TABLE, PermissionLevels.READ), tableController.find)
+    .get("/api/tables/:tableId", paramResource("tableId"), authorized(PermissionTypes.TABLE, PermissionLevels.READ), tableController.find)
     /**
      * @api {post} /api/tables Save a table
      * @apiName Save a table
@@ -122,7 +108,7 @@ router
      */
     .post("/api/tables", 
 // allows control over updating a table
-bodyResource("_id"), authorized(BUILDER), generateSaveValidator(), tableController.save)
+bodyResource("_id"), authorized(BUILDER), tableValidator(), tableController.save)
     /**
      * @api {post} /api/tables/csv/validate Validate a CSV for a table
      * @apiName Validate a CSV for a table

package/dist/api/routes/tests/utilities/index.js

@@ -11,6 +11,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 const TestConfig = require("../../../../tests/utilities/TestConfiguration");
 const structures = require("../../../../tests/utilities/structures");
 const env = require("../../../../environment");
+function user() {
+    return {
+        _id: "user",
+        _rev: "rev",
+        createdAt: Date.now(),
+        email: "test@test.com",
+        roles: {},
+        tenantId: "default",
+        status: "active",
+    };
+}
 jest.mock("../../../../utilities/workerRequests", () => ({
     getGlobalUsers: jest.fn(() => {
         return {
@@ -22,6 +33,18 @@ jest.mock("../../../../utilities/workerRequests", () => ({
             _id: "us_uuid1",
         };
     }),
+    allGlobalUsers: jest.fn(() => {
+        return [user()];
+    }),
+    readGlobalUser: jest.fn(() => {
+        return user();
+    }),
+    saveGlobalUser: jest.fn(() => {
+        return { _id: "user", _rev: "rev" };
+    }),
+    deleteGlobalUser: jest.fn(() => {
+        return { message: "deleted user" };
+    }),
     removeAppFromUserRoles: jest.fn(),
 }));
 exports.delay = ms => new Promise(resolve => setTimeout(resolve, ms));

package/dist/api/routes/utils/validators.js

@@ -0,0 +1,200 @@
+"use strict";
+const joiValidator = require("../../../middleware/joi-validator");
+const { DataSourceOperation } = require("../../../constants");
+const { WebhookType } = require("../../../constants");
+const { BUILTIN_PERMISSION_IDS, PermissionLevels, } = require("@budibase/backend-core/permissions");
+const Joi = require("joi");
+const OPTIONAL_STRING = Joi.string().optional().allow(null).allow("");
+const OPTIONAL_NUMBER = Joi.number().optional().allow(null);
+exports.tableValidator = () => {
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        _id: OPTIONAL_STRING,
+        _rev: OPTIONAL_STRING,
+        type: OPTIONAL_STRING.valid("table", "internal", "external"),
+        primaryDisplay: OPTIONAL_STRING,
+        schema: Joi.object().required(),
+        name: Joi.string().required(),
+        views: Joi.object(),
+        dataImport: Joi.object(),
+    }).unknown(true));
+};
+exports.nameValidator = () => {
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        name: OPTIONAL_STRING,
+    }));
+};
+exports.datasourceValidator = () => {
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        _id: Joi.string(),
+        _rev: Joi.string(),
+        type: OPTIONAL_STRING.allow("datasource_plus"),
+        relationships: Joi.array().items(Joi.object({
+            from: Joi.string().required(),
+            to: Joi.string().required(),
+            cardinality: Joi.valid("1:N", "1:1", "N:N").required()
+        })),
+    }).unknown(true));
+};
+function filterObject() {
+    // prettier-ignore
+    return Joi.object({
+        string: Joi.object().optional(),
+        fuzzy: Joi.object().optional(),
+        range: Joi.object().optional(),
+        equal: Joi.object().optional(),
+        notEqual: Joi.object().optional(),
+        empty: Joi.object().optional(),
+        notEmpty: Joi.object().optional(),
+        oneOf: Joi.object().optional(),
+        contains: Joi.object().optional(),
+        notContains: Joi.object().optional(),
+    }).unknown(true);
+}
+exports.internalSearchValidator = () => {
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        tableId: OPTIONAL_STRING,
+        query: filterObject(),
+        limit: OPTIONAL_NUMBER,
+        sort: OPTIONAL_STRING,
+        sortOrder: OPTIONAL_STRING,
+        sortType: OPTIONAL_STRING,
+        paginate: Joi.boolean(),
+        bookmark: Joi.alternatives().try(OPTIONAL_STRING, OPTIONAL_NUMBER).optional(),
+    }));
+};
+exports.externalSearchValidator = () => {
+    return joiValidator.body(Joi.object({
+        query: filterObject(),
+        paginate: Joi.boolean().optional(),
+        bookmark: Joi.alternatives()
+            .try(OPTIONAL_STRING, OPTIONAL_NUMBER)
+            .optional(),
+        limit: OPTIONAL_NUMBER,
+        sort: Joi.object({
+            column: Joi.string(),
+            order: OPTIONAL_STRING.valid("ascending", "descending"),
+            type: OPTIONAL_STRING.valid("string", "number"),
+        }).optional(),
+    }));
+};
+exports.datasourceQueryValidator = () => {
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        endpoint: Joi.object({
+            datasourceId: Joi.string().required(),
+            operation: Joi.string().required().valid(...Object.values(DataSourceOperation)),
+            entityId: Joi.string().required(),
+        }).required(),
+        resource: Joi.object({
+            fields: Joi.array().items(Joi.string()).optional(),
+        }).optional(),
+        body: Joi.object().optional(),
+        sort: Joi.object().optional(),
+        filters: filterObject().optional(),
+        paginate: Joi.object({
+            page: Joi.string().alphanum().optional(),
+            limit: Joi.number().optional(),
+        }).optional(),
+    }));
+};
+exports.webhookValidator = () => {
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        live: Joi.bool(),
+        _id: OPTIONAL_STRING,
+        _rev: OPTIONAL_STRING,
+        name: Joi.string().required(),
+        bodySchema: Joi.object().optional(),
+        action: Joi.object({
+            type: Joi.string().required().valid(WebhookType.AUTOMATION),
+            target: Joi.string().required(),
+        }).required(),
+    }).unknown(true));
+};
+exports.roleValidator = () => {
+    const permLevelArray = Object.values(PermissionLevels);
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        _id: OPTIONAL_STRING,
+        _rev: OPTIONAL_STRING,
+        name: Joi.string().required(),
+        // this is the base permission ID (for now a built in)
+        permissionId: Joi.string().valid(...Object.values(BUILTIN_PERMISSION_IDS)).required(),
+        permissions: Joi.object()
+            .pattern(/.*/, [Joi.string().valid(...permLevelArray)])
+            .optional(),
+        inherits: OPTIONAL_STRING,
+    }).unknown(true));
+};
+exports.permissionValidator = () => {
+    const permLevelArray = Object.values(PermissionLevels);
+    // prettier-ignore
+    return joiValidator.params(Joi.object({
+        level: Joi.string().valid(...permLevelArray).required(),
+        resourceId: Joi.string(),
+        roleId: Joi.string(),
+    }).unknown(true));
+};
+exports.screenValidator = () => {
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        name: Joi.string().required(),
+        routing: Joi.object({
+            route: Joi.string().required(),
+            roleId: Joi.string().required().allow(""),
+        }).required().unknown(true),
+        props: Joi.object({
+            _id: Joi.string().required(),
+            _component: Joi.string().required(),
+            _children: Joi.array().required(),
+            _instanceName: Joi.string().required(),
+            _styles: Joi.object().required(),
+            type: OPTIONAL_STRING,
+            table: OPTIONAL_STRING,
+            layoutId: OPTIONAL_STRING,
+        }).required().unknown(true),
+    }).unknown(true));
+};
+function generateStepSchema(allowStepTypes) {
+    // prettier-ignore
+    return Joi.object({
+        stepId: Joi.string().required(),
+        id: Joi.string().required(),
+        description: Joi.string().required(),
+        name: Joi.string().required(),
+        tagline: Joi.string().required(),
+        icon: Joi.string().required(),
+        params: Joi.object(),
+        args: Joi.object(),
+        type: Joi.string().required().valid(...allowStepTypes),
+    }).unknown(true);
+}
+exports.automationValidator = (existing = false) => {
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        _id: existing ? Joi.string().required() : OPTIONAL_STRING,
+        _rev: existing ? Joi.string().required() : OPTIONAL_STRING,
+        name: Joi.string().required(),
+        type: Joi.string().valid("automation").required(),
+        definition: Joi.object({
+            steps: Joi.array().required().items(generateStepSchema(["ACTION", "LOGIC"])),
+            trigger: generateStepSchema(["TRIGGER"]).allow(null),
+        }).required().unknown(true),
+    }).unknown(true));
+};
+exports.applicationValidator = () => {
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        _id: OPTIONAL_STRING,
+        _rev: OPTIONAL_STRING,
+        name: Joi.string().required(),
+        url: OPTIONAL_STRING,
+        template: Joi.object({
+            templateString: OPTIONAL_STRING,
+        }).unknown(true),
+    }).unknown(true));
+};

package/dist/api/routes/webhook.js

@@ -2,27 +2,12 @@
 const Router = require("@koa/router");
 const controller = require("../controllers/webhook");
 const authorized = require("../../middleware/authorized");
-const joiValidator = require("../../middleware/joi-validator");
 const { BUILDER } = require("@budibase/backend-core/permissions");
-const Joi = require("joi");
+const { webhookValidator } = require("./utils/validators");
 const router = Router();
-function generateSaveValidator() {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        live: Joi.bool(),
-        _id: Joi.string().optional(),
-        _rev: Joi.string().optional(),
-        name: Joi.string().required(),
-        bodySchema: Joi.object().optional(),
-        action: Joi.object({
-            type: Joi.string().required().valid(controller.WebhookType.AUTOMATION),
-            target: Joi.string().required(),
-        }).required(),
-    }).unknown(true));
-}
 router
     .get("/api/webhooks", authorized(BUILDER), controller.fetch)
-    .put("/api/webhooks", authorized(BUILDER), generateSaveValidator(), controller.save)
+    .put("/api/webhooks", authorized(BUILDER), webhookValidator(), controller.save)
     .delete("/api/webhooks/:id/:rev", authorized(BUILDER), controller.destroy)
     .post("/api/webhooks/schema/:instance/:id", authorized(BUILDER), controller.buildSchema)
     // this shouldn't have authorisation, right now its always public

package/dist/automations/steps/filter.js

@@ -23,10 +23,10 @@ const PrettyFilterConditions = {
 exports.FilterConditions = FilterConditions;
 exports.PrettyFilterConditions = PrettyFilterConditions;
 exports.definition = {
-    name: "Filter",
+    name: "Condition",
     tagline: "{{inputs.field}} {{inputs.condition}} {{inputs.value}}",
     icon: "Branch2",
-    description: "Filter any automations which do not meet certain conditions",
+    description: "Conditionally halt automations which do not meet certain conditions",
     type: "LOGIC",
     internal: true,
     stepId: "FILTER",

package/dist/automations/steps/queryRows.js

@@ -81,7 +81,7 @@ function getTable(appId, tableId) {
     return __awaiter(this, void 0, void 0, function* () {
         const ctx = buildCtx(appId, null, {
             params: {
-                id: tableId,
+                tableId,
             },
         });
         yield tableController.find(ctx);

package/dist/automations/utils.js

@@ -15,7 +15,7 @@ const CouchDB = require("../db");
 const { queue } = require("./bullboard");
 const newid = require("../db/newid");
 const { updateEntityMetadata } = require("../utilities");
-const { MetadataTypes } = require("../constants");
+const { MetadataTypes, WebhookType } = require("../constants");
 const { getProdAppID } = require("@budibase/backend-core/db");
 const { cloneDeep } = require("lodash/fp");
 const { getAppDB, getAppId } = require("@budibase/backend-core/context");
@@ -145,7 +145,7 @@ exports.checkForWebhooks = ({ oldAuto, newAuto }) => __awaiter(void 0, void 0, v
         const ctx = {
             appId,
             request: {
-                body: new webhooks.Webhook("Automation webhook", webhooks.WebhookType.AUTOMATION, newAuto._id),
+                body: new webhooks.Webhook("Automation webhook", WebhookType.AUTOMATION, newAuto._id),
             },
         };
         yield webhooks.save(ctx);

package/dist/constants/index.js

@@ -166,5 +166,8 @@ exports.BuildSchemaErrors = {
     NO_KEY: "no_key",
     INVALID_COLUMN: "invalid_column",
 };
+exports.WebhookType = {
+    AUTOMATION: "automation",
+};
 // pass through the list from the auth/core lib
 exports.ObjectStoreBuckets = ObjectStoreBuckets;

package/dist/db/utils.js

@@ -114,6 +114,17 @@ exports.getRowParams = (tableId = null, rowId = null, otherProps = {}) => {
     const endOfKey = rowId == null ? `${tableId}${SEPARATOR}` : rowId;
     return getDocParams(DocumentTypes.ROW, endOfKey, otherProps);
 };
+/**
+ * Given a row ID this will find the table ID within it (only works for internal tables).
+ * @param {string} rowId The ID of the row.
+ * @returns {string} The table ID.
+ */
+exports.getTableIDFromRowID = rowId => {
+    const components = rowId
+        .split(DocumentTypes.TABLE + SEPARATOR)[1]
+        .split(SEPARATOR);
+    return `${DocumentTypes.TABLE}${SEPARATOR}${components[0]}`;
+};
 /**
  * Gets a new row ID for the specified table.
  * @param {string} tableId The table which the row is being created for.

package/dist/definitions/openapi.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/integrations/googlesheets.js

@@ -97,6 +97,9 @@ var GoogleSheetsModule;
             const spreadsheetId = this.cleanSpreadsheetUrl(this.config.spreadsheetId);
             this.client = new google_spreadsheet_1.GoogleSpreadsheet(spreadsheetId);
         }
+        getBindingIdentifier() {
+            return "";
+        }
         /**
          * Pull the spreadsheet ID out from a valid google sheets URL
          * @param spreadsheetId - the URL or standard spreadsheetId of the google sheet

package/dist/integrations/microsoftSqlServer.js

@@ -63,32 +63,10 @@ var MSSQLModule;
             },
         },
     };
-    function internalQuery(client, query, operation = undefined) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const request = client.request();
-            try {
-                if (Array.isArray(query.bindings)) {
-                    let count = 0;
-                    for (let binding of query.bindings) {
-                        request.input(`p${count++}`, binding);
-                    }
-                }
-                // this is a hack to get the inserted ID back,
-                //  no way to do this with Knex nicely
-                const sql = operation === datasource_1.Operation.CREATE
-                    ? `${query.sql}; SELECT SCOPE_IDENTITY() AS id;`
-                    : query.sql;
-                return yield request.query(sql);
-            }
-            catch (err) {
-                // @ts-ignore
-                throw new Error(err);
-            }
-        });
-    }
     class SqlServerIntegration extends Sql {
         constructor(config) {
             super(utils_1.SqlClients.MS_SQL);
+            this.index = 0;
             this.tables = {};
             this.schemaErrors = {};
             this.MASTER_TABLES = [
@@ -109,6 +87,31 @@ var MSSQLModule;
                 this.pool = new sqlServer.ConnectionPool(clientCfg);
             }
         }
+        internalQuery(query, operation = undefined) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const client = this.client;
+                const request = client.request();
+                this.index = 0;
+                try {
+                    if (Array.isArray(query.bindings)) {
+                        let count = 0;
+                        for (let binding of query.bindings) {
+                            request.input(`p${count++}`, binding);
+                        }
+                    }
+                    // this is a hack to get the inserted ID back,
+                    //  no way to do this with Knex nicely
+                    const sql = operation === datasource_1.Operation.CREATE
+                        ? `${query.sql}; SELECT SCOPE_IDENTITY() AS id;`
+                        : query.sql;
+                    return yield request.query(sql);
+                }
+                catch (err) {
+                    // @ts-ignore
+                    throw new Error(err);
+                }
+            });
+        }
         getDefinitionSQL(tableName) {
             return `select *
               from INFORMATION_SCHEMA.COLUMNS
@@ -134,6 +137,9 @@ var MSSQLModule;
               FROM INFORMATION_SCHEMA.COLUMNS
               WHERE TABLE_NAME='${tableName}'`;
         }
+        getBindingIdentifier() {
+            return `(@p${this.index++})`;
+        }
         connect() {
             return __awaiter(this, void 0, void 0, function* () {
                 try {
@@ -147,7 +153,7 @@ var MSSQLModule;
         }
         runSQL(sql) {
             return __awaiter(this, void 0, void 0, function* () {
-                return (yield internalQuery(this.client, utils_1.getSqlQuery(sql))).recordset;
+                return (yield this.internalQuery(utils_1.getSqlQuery(sql))).recordset;
             });
         }
         /**
@@ -207,28 +213,28 @@ var MSSQLModule;
         read(query) {
             return __awaiter(this, void 0, void 0, function* () {
                 yield this.connect();
-                const response = yield internalQuery(this.client, utils_1.getSqlQuery(query));
+                const response = yield this.internalQuery(utils_1.getSqlQuery(query));
                 return response.recordset;
             });
         }
         create(query) {
             return __awaiter(this, void 0, void 0, function* () {
                 yield this.connect();
-                const response = yield internalQuery(this.client, utils_1.getSqlQuery(query));
+                const response = yield this.internalQuery(utils_1.getSqlQuery(query));
                 return response.recordset || [{ created: true }];
             });
         }
         update(query) {
             return __awaiter(this, void 0, void 0, function* () {
                 yield this.connect();
-                const response = yield internalQuery(this.client, utils_1.getSqlQuery(query));
+                const response = yield this.internalQuery(utils_1.getSqlQuery(query));
                 return response.recordset || [{ updated: true }];
             });
         }
         delete(query) {
             return __awaiter(this, void 0, void 0, function* () {
                 yield this.connect();
-                const response = yield internalQuery(this.client, utils_1.getSqlQuery(query));
+                const response = yield this.internalQuery(utils_1.getSqlQuery(query));
                 return response.recordset || [{ deleted: true }];
             });
         }
@@ -236,7 +242,7 @@ var MSSQLModule;
             return __awaiter(this, void 0, void 0, function* () {
                 yield this.connect();
                 const operation = this._operation(json);
-                const queryFn = (query, op) => internalQuery(this.client, query, op);
+                const queryFn = (query, op) => this.internalQuery(query, op);
                 const processFn = (result) => result.recordset ? result.recordset : [{ [operation]: true }];
                 return this.queryWithReturning(json, queryFn, processFn);
             });

package/dist/integrations/mysql.js

@@ -65,25 +65,6 @@ var MySQLModule;
             },
         },
     };
-    function internalQuery(client, query, connect = true) {
-        // Node MySQL is callback based, so we must wrap our call in a promise
-        return new Promise((resolve, reject) => {
-            if (connect) {
-                client.connect();
-            }
-            return client.query(query.sql, query.bindings || {}, (error, results) => {
-                if (error) {
-                    reject(error);
-                }
-                else {
-                    resolve(results);
-                }
-                if (connect) {
-                    client.end();
-                }
-            });
-        });
-    }
     class MySQLIntegration extends Sql {
         constructor(config) {
             super(utils_1.SqlClients.MY_SQL);
@@ -95,19 +76,42 @@ var MySQLModule;
             }
             this.client = mysql.createConnection(config);
         }
+        getBindingIdentifier() {
+            return "?";
+        }
+        internalQuery(query, connect = true) {
+            const client = this.client;
+            // Node MySQL is callback based, so we must wrap our call in a promise
+            return new Promise((resolve, reject) => {
+                if (connect) {
+                    client.connect();
+                }
+                return client.query(query.sql, query.bindings || {}, (error, results) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        resolve(results);
+                    }
+                    if (connect) {
+                        client.end();
+                    }
+                });
+            });
+        }
         buildSchema(datasourceId, entities) {
             return __awaiter(this, void 0, void 0, function* () {
                 const tables = {};
                 const database = this.config.database;
                 this.client.connect();
                 // get the tables first
-                const tablesResp = yield internalQuery(this.client, { sql: "SHOW TABLES;" }, false);
+                const tablesResp = yield this.internalQuery({ sql: "SHOW TABLES;" }, false);
                 const tableNames = tablesResp.map((obj) => obj[`Tables_in_${database}`] ||
                     obj[`Tables_in_${database.toLowerCase()}`]);
                 for (let tableName of tableNames) {
                     const primaryKeys = [];
                     const schema = {};
-                    const descResp = yield internalQuery(this.client, { sql: `DESCRIBE \`${tableName}\`;` }, false);
+                    const descResp = yield this.internalQuery({ sql: `DESCRIBE \`${tableName}\`;` }, false);
                     for (let column of descResp) {
                         const columnName = column.Field;
                         if (column.Key === "PRI" && primaryKeys.indexOf(column.Key) === -1) {
@@ -143,31 +147,31 @@ var MySQLModule;
         }
         create(query) {
             return __awaiter(this, void 0, void 0, function* () {
-                const results = yield internalQuery(this.client, utils_1.getSqlQuery(query));
+                const results = yield this.internalQuery(utils_1.getSqlQuery(query));
                 return results.length ? results : [{ created: true }];
             });
         }
         read(query) {
             return __awaiter(this, void 0, void 0, function* () {
-                return internalQuery(this.client, utils_1.getSqlQuery(query));
+                return this.internalQuery(utils_1.getSqlQuery(query));
             });
         }
         update(query) {
             return __awaiter(this, void 0, void 0, function* () {
-                const results = yield internalQuery(this.client, utils_1.getSqlQuery(query));
+                const results = yield this.internalQuery(utils_1.getSqlQuery(query));
                 return results.length ? results : [{ updated: true }];
             });
         }
         delete(query) {
             return __awaiter(this, void 0, void 0, function* () {
-                const results = yield internalQuery(this.client, utils_1.getSqlQuery(query));
+                const results = yield this.internalQuery(utils_1.getSqlQuery(query));
                 return results.length ? results : [{ deleted: true }];
             });
         }
         query(json) {
             return __awaiter(this, void 0, void 0, function* () {
                 this.client.connect();
-                const queryFn = (query) => internalQuery(this.client, query, false);
+                const queryFn = (query) => this.internalQuery(query, false);
                 const output = yield this.queryWithReturning(json, queryFn);
                 this.client.end();
                 return output;