@budibase/server 1.0.79-alpha.4 → 1.0.79-alpha.7

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/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/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@budibase/server",
     "email": "hi@budibase.com",
-    "version": "1.0.79-alpha.3",
+    "version": "1.0.79-alpha.6",
     "description": "Budibase Web Server",
     "main": "src/index.ts",
     "repository": {
@@ -25,6 +25,7 @@
         "generate:proxy:preprod": "node scripts/proxy/generateProxyConfig preprod",
         "generate:proxy:prod": "node scripts/proxy/generateProxyConfig prod",
         "format": "prettier --config ../../.prettierrc.json 'src/**/*.ts' --write",
+        "specs": "node specs/generate.js && openapi-typescript specs/openapi.yaml --output src/definitions/openapi.ts",
         "lint": "eslint --fix src/",
         "lint:fix": "yarn run format && yarn run lint",
         "initialise": "node scripts/initialise.js",
@@ -73,9 +74,9 @@
     "license": "GPL-3.0",
     "dependencies": {
         "@apidevtools/swagger-parser": "^10.0.3",
-        "@budibase/backend-core": "^1.0.79-alpha.3",
-        "@budibase/client": "^1.0.79-alpha.3",
-        "@budibase/string-templates": "^1.0.79-alpha.3",
+        "@budibase/backend-core": "^1.0.79-alpha.6",
+        "@budibase/client": "^1.0.79-alpha.6",
+        "@budibase/string-templates": "^1.0.79-alpha.6",
         "@bull-board/api": "^3.7.0",
         "@bull-board/koa": "^3.7.0",
         "@elastic/elasticsearch": "7.10.0",
@@ -157,12 +158,15 @@
         "docker-compose": "^0.23.6",
         "eslint": "^6.8.0",
         "jest": "^27.0.5",
+        "jest-openapi": "^0.14.2",
         "nodemon": "^2.0.4",
         "openapi-types": "^9.3.1",
+        "openapi-typescript": "^5.2.0",
         "path-to-regexp": "^6.2.0",
         "prettier": "^2.3.1",
         "rimraf": "^3.0.2",
         "supertest": "^4.0.2",
+        "swagger-jsdoc": "^6.1.0",
         "ts-jest": "^27.0.3",
         "ts-node": "^10.0.0",
         "typescript": "^4.3.5",

package/dist/tests/utilities/TestConfiguration.js

@@ -24,6 +24,8 @@ const { createASession } = require("@budibase/backend-core/sessions");
 const { user: userCache } = require("@budibase/backend-core/cache");
 const newid = require("../../db/newid");
 const context = require("@budibase/backend-core/context");
+const { generateDevInfoID, SEPARATOR } = require("@budibase/backend-core/db");
+const { encrypt } = require("@budibase/backend-core/encryption");
 const GLOBAL_USER_ID = "us_uuid1";
 const EMAIL = "babs@babs.com";
 const CSRF_TOKEN = "e3727778-7af0-4226-b5eb-f43cbe60a306";
@@ -42,6 +44,9 @@ class TestConfiguration {
     getRequest() {
         return this.request;
     }
+    getApp() {
+        return this.app;
+    }
     getAppId() {
         return this.appId;
     }
@@ -80,6 +85,22 @@ class TestConfiguration {
             }
         });
     }
+    generateApiKey(userId = GLOBAL_USER_ID) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const db = getGlobalDB(TENANT_ID);
+            const id = generateDevInfoID(userId);
+            let devInfo;
+            try {
+                devInfo = yield db.get(id);
+            }
+            catch (err) {
+                devInfo = { _id: id, userId };
+            }
+            devInfo.apiKey = encrypt(`${TENANT_ID}${SEPARATOR}${newid()}`);
+            yield db.put(devInfo);
+            return devInfo.apiKey;
+        });
+    }
     globalUser({ id = GLOBAL_USER_ID, builder = true, email = EMAIL, roles, } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const db = getGlobalDB(TENANT_ID);
@@ -122,7 +143,7 @@ class TestConfiguration {
         }
         cleanup(this.allApps.map(app => app.appId));
     }
-    defaultHeaders() {
+    defaultHeaders(extras = {}) {
         const auth = {
             userId: GLOBAL_USER_ID,
             sessionId: "sessionid",
@@ -134,14 +155,10 @@ class TestConfiguration {
         };
         const authToken = jwt.sign(auth, env.JWT_SECRET);
         const appToken = jwt.sign(app, env.JWT_SECRET);
-        const headers = {
-            Accept: "application/json",
-            Cookie: [
+        const headers = Object.assign({ Accept: "application/json", Cookie: [
                 `${Cookies.Auth}=${authToken}`,
                 `${Cookies.CurrentApp}=${appToken}`,
-            ],
-            [Headers.CSRF_TOKEN]: CSRF_TOKEN,
-        };
+            ], [Headers.CSRF_TOKEN]: CSRF_TOKEN }, extras);
         if (this.appId) {
             headers[Headers.APP_ID] = this.appId;
         }
@@ -204,7 +221,7 @@ class TestConfiguration {
     getTable(tableId = null) {
         return __awaiter(this, void 0, void 0, function* () {
             tableId = tableId || this.table._id;
-            return this._req(null, { id: tableId }, controllers.table.find);
+            return this._req(null, { tableId }, controllers.table.find);
         });
     }
     createLinkedTable(relationshipType = null, links = ["link"]) {