@budibase/server 1.0.79 → 1.0.80-alpha.2

package/dist/api/routes/public/rows.js

@@ -0,0 +1,229 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const rows_1 = __importDefault(require("../../controllers/public/rows"));
+const Endpoint_1 = __importDefault(require("./utils/Endpoint"));
+const validators_1 = require("../utils/validators");
+const read = [], write = [];
+/**
+ * @openapi
+ * /tables/{tableId}/rows:
+ *   post:
+ *     summary: Create a row
+ *     description: Creates a row within the specified table.
+ *     tags:
+ *       - rows
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/row'
+ *           examples:
+ *             row:
+ *               $ref: '#/components/examples/inputRow'
+ *     responses:
+ *       200:
+ *         description: Returns the created row, including the ID which has been generated for it.
+ *           This can be found in the Budibase portal, viewed under the developer information.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/rowOutput'
+ *             examples:
+ *               row:
+ *                 $ref: '#/components/examples/row'
+ */
+write.push(new Endpoint_1.default("post", "/tables/:tableId/rows", rows_1.default.create));
+/**
+ * @openapi
+ * /tables/{tableId}/rows/{rowId}:
+ *   put:
+ *     summary: Update a row
+ *     description: Updates a row within the specified table.
+ *     tags:
+ *       - rows
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/rowId'
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/row'
+ *           examples:
+ *             row:
+ *               $ref: '#/components/examples/inputRow'
+ *     responses:
+ *       200:
+ *         description: Returns the created row, including the ID which has been generated for it.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/rowOutput'
+ *             examples:
+ *               row:
+ *                 $ref: '#/components/examples/row'
+ */
+write.push(new Endpoint_1.default("put", "/tables/:tableId/rows/:rowId", rows_1.default.update));
+/**
+ * @openapi
+ * /tables/{tableId}/rows/{rowId}:
+ *   delete:
+ *     summary: Delete a row
+ *     description: Deletes a row within the specified table.
+ *     tags:
+ *       - rows
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/rowId'
+ *       - $ref: '#/components/parameters/appId'
+ *     responses:
+ *       200:
+ *         description: Returns the deleted row, including the ID which has been generated for it.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/rowOutput'
+ *             examples:
+ *               row:
+ *                 $ref: '#/components/examples/row'
+ */
+write.push(new Endpoint_1.default("delete", "/tables/:tableId/rows/:rowId", rows_1.default.destroy));
+/**
+ * @openapi
+ * /tables/{tableId}/rows/{rowId}:
+ *   get:
+ *     summary: Retrieve a row
+ *     description: This gets a single row, it will be enriched with the full related rows, rather than
+ *       the squashed "primaryDisplay" format returned by the search endpoint.
+ *     tags:
+ *       - rows
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/rowId'
+ *       - $ref: '#/components/parameters/appId'
+ *     responses:
+ *       200:
+ *         description: Returns the retrieved row.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/rowOutput'
+ *             examples:
+ *               enrichedRow:
+ *                 $ref: '#/components/examples/enrichedRow'
+ */
+read.push(new Endpoint_1.default("get", "/tables/:tableId/rows/:rowId", rows_1.default.read));
+/**
+ * @openapi
+ * /tables/{tableId}/rows/search:
+ *   post:
+ *     summary: Search for rows
+ *     tags:
+ *       - rows
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required:
+ *               - query
+ *             properties:
+ *               query:
+ *                 type: object
+ *                 properties:
+ *                   string:
+ *                     type: object
+ *                     example:
+ *                       columnName1: value
+ *                       columnName2: value
+ *                     description: A map of field name to the string to search for,
+ *                       this will look for rows that have a value starting with the
+ *                       string value.
+ *                     additionalProperties:
+ *                       type: string
+ *                       description: The value to search for in the column.
+ *                   fuzzy:
+ *                     type: object
+ *                     description: A fuzzy search, only supported by internal tables.
+ *                   range:
+ *                     type: object
+ *                     description: Searches within a range, the format of this must be
+ *                       columnName -> [low, high].
+ *                     example:
+ *                       columnName1: [10, 20]
+ *                   equal:
+ *                     type: object
+ *                     description: Searches for rows that have a column value that is
+ *                       exactly the value set.
+ *                   notEqual:
+ *                     type: object
+ *                     description: Searches for any row which does not contain the specified
+ *                       column value.
+ *                   empty:
+ *                     type: object
+ *                     description: Searches for rows which do not contain the specified column.
+ *                       The object should simply contain keys of the column names, these
+ *                       can map to any value.
+ *                     example:
+ *                       columnName1: ""
+ *                   notEmpty:
+ *                     type: object
+ *                     description: Searches for rows which have the specified column.
+ *                   oneOf:
+ *                     type: object
+ *                     description: Searches for rows which have a column value that is any
+ *                       of the specified values. The format of this must be columnName -> [value1, value2].
+ *               paginate:
+ *                 type: boolean
+ *                 description: Enables pagination, by default this is disabled.
+ *               bookmark:
+ *                 oneOf:
+ *                   - type: string
+ *                   - type: integer
+ *                 description: If retrieving another page, the bookmark from the previous request must be supplied.
+ *               limit:
+ *                 type: integer
+ *                 description: The maximum number of rows to return, useful when paginating, for internal tables this
+ *                   will be limited to 1000, for SQL tables it will be 5000.
+ *               sort:
+ *                 type: object
+ *                 description: A set of parameters describing the sort behaviour of the search.
+ *                 properties:
+ *                   order:
+ *                     type: string
+ *                     enum: [ascending, descending]
+ *                     description: The order of the sort, by default this is ascending.
+ *                   column:
+ *                     type: string
+ *                     description: The name of the column by which the rows will be sorted.
+ *                   type:
+ *                     type: string
+ *                     enum: [string, number]
+ *                     description: Defines whether the column should be treated as a string
+ *                       or as numbers when sorting.
+ *     responses:
+ *       200:
+ *         description: The response will contain an array of rows that match the search parameters.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/searchOutput'
+ *             examples:
+ *               search:
+ *                 $ref: '#/components/examples/rows'
+ */
+read.push(new Endpoint_1.default("post", "/tables/:tableId/rows/search", rows_1.default.search).addMiddleware(validators_1.externalSearchValidator()));
+exports.default = { read, write };

package/dist/api/routes/public/tables.js

@@ -0,0 +1,154 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const tables_1 = __importDefault(require("../../controllers/public/tables"));
+const Endpoint_1 = __importDefault(require("./utils/Endpoint"));
+const validators_1 = require("../utils/validators");
+const read = [], write = [];
+/**
+ * @openapi
+ * /tables:
+ *   post:
+ *     summary: Create a table
+ *     description: Create a table, this could be internal or external.
+ *     tags:
+ *       - tables
+ *     parameters:
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/table'
+ *           examples:
+ *             table:
+ *               $ref: '#/components/examples/table'
+ *     responses:
+ *       200:
+ *         description: Returns the created table, including the ID which has been generated for it. This can be
+ *           internal or external data sources.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/tableOutput'
+ *             examples:
+ *               table:
+ *                 $ref: '#/components/examples/table'
+ */
+write.push(new Endpoint_1.default("post", "/tables", tables_1.default.create).addMiddleware(validators_1.tableValidator()));
+/**
+ * @openapi
+ * /tables/{tableId}:
+ *   put:
+ *     summary: Update a table
+ *     description: Update a table, this could be internal or external.
+ *     tags:
+ *       - tables
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/table'
+ *           examples:
+ *             table:
+ *               $ref: '#/components/examples/table'
+ *     responses:
+ *       200:
+ *         description: Returns the updated table.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/tableOutput'
+ *             examples:
+ *               table:
+ *                 $ref: '#/components/examples/table'
+ */
+write.push(new Endpoint_1.default("put", "/tables/:tableId", tables_1.default.update).addMiddleware(validators_1.tableValidator()));
+/**
+ * @openapi
+ * /tables/{tableId}:
+ *   delete:
+ *     summary: Delete a table
+ *     description: Delete a table, this could be internal or external.
+ *     tags:
+ *       - tables
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/appId'
+ *     responses:
+ *       200:
+ *         description: Returns the deleted table.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/tableOutput'
+ *             examples:
+ *               table:
+ *                 $ref: '#/components/examples/table'
+ */
+write.push(new Endpoint_1.default("delete", "/tables/:tableId", tables_1.default.destroy));
+/**
+ * @openapi
+ * /tables/{tableId}:
+ *   get:
+ *     summary: Retrieve a table
+ *     description: Lookup a table, this could be internal or external.
+ *     tags:
+ *       - tables
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/appId'
+ *     responses:
+ *       200:
+ *         description: Returns the retrieved table.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/tableOutput'
+ *             examples:
+ *               table:
+ *                 $ref: '#/components/examples/table'
+ */
+read.push(new Endpoint_1.default("get", "/tables/:tableId", tables_1.default.read));
+/**
+ * @openapi
+ * /tables/search:
+ *   post:
+ *     summary: Search for tables
+ *     description: Based on table properties (currently only name) search for tables. This could be
+ *       an internal or an external table.
+ *     tags:
+ *       - tables
+ *     parameters:
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/nameSearch'
+ *     responses:
+ *       200:
+ *         description: Returns the found tables, based on the search parameters.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - data
+ *               properties:
+ *                 data:
+ *                   type: array
+ *                   items:
+ *                     $ref: '#/components/schemas/table'
+ *             examples:
+ *               tables:
+ *                 $ref: '#/components/examples/tables'
+ */
+read.push(new Endpoint_1.default("post", "/tables/search", tables_1.default.search).addMiddleware(validators_1.nameValidator()));
+exports.default = { read, write };

package/dist/api/routes/public/users.js

@@ -0,0 +1,137 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const users_1 = __importDefault(require("../../controllers/public/users"));
+const Endpoint_1 = __importDefault(require("./utils/Endpoint"));
+const validators_1 = require("../utils/validators");
+const read = [], write = [];
+/**
+ * @openapi
+ * /users:
+ *   post:
+ *     summary: Create a user
+ *     tags:
+ *       - users
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/user'
+ *     responses:
+ *       200:
+ *         description: Returns the created user.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/userOutput'
+ *             examples:
+ *               user:
+ *                 $ref: '#/components/examples/user'
+ */
+write.push(new Endpoint_1.default("post", "/users", users_1.default.create));
+/**
+ * @openapi
+ * /users/{userId}:
+ *   put:
+ *     summary: Update a user
+ *     tags:
+ *       - users
+ *     parameters:
+ *       - $ref: '#/components/parameters/userId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/user'
+ *     responses:
+ *       200:
+ *         description: Returns the updated user.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/userOutput'
+ *             examples:
+ *               user:
+ *                 $ref: '#/components/examples/user'
+ */
+write.push(new Endpoint_1.default("put", "/users/:userId", users_1.default.update));
+/**
+ * @openapi
+ * /users/{userId}:
+ *   delete:
+ *     summary: Delete a user
+ *     tags:
+ *       - users
+ *     parameters:
+ *       - $ref: '#/components/parameters/userId'
+ *     responses:
+ *       200:
+ *         description: Returns the deleted user.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/userOutput'
+ *             examples:
+ *               user:
+ *                 $ref: '#/components/examples/user'
+ */
+write.push(new Endpoint_1.default("delete", "/users/:userId", users_1.default.destroy));
+/**
+ * @openapi
+ * /users/{userId}:
+ *   get:
+ *     summary: Retrieve a user
+ *     tags:
+ *       - users
+ *     parameters:
+ *       - $ref: '#/components/parameters/userId'
+ *     responses:
+ *       200:
+ *         description: Returns the retrieved user.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/userOutput'
+ *             examples:
+ *               user:
+ *                 $ref: '#/components/examples/user'
+ */
+read.push(new Endpoint_1.default("get", "/users/:userId", users_1.default.read));
+/**
+ * @openapi
+ * /users/search:
+ *   post:
+ *     summary: Search for users
+ *     description: Based on user properties (currently only name) search for users.
+ *     tags:
+ *       - users
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/nameSearch'
+ *     responses:
+ *       200:
+ *         description: Returns the found users based on search parameters.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - data
+ *               properties:
+ *                 data:
+ *                   type: array
+ *                   items:
+ *                     $ref: '#/components/schemas/user'
+ *             examples:
+ *               users:
+ *                 $ref: '#/components/examples/users'
+ */
+read.push(new Endpoint_1.default("post", "/users/search", users_1.default.search).addMiddleware(validators_1.nameValidator()));
+exports.default = { read, write };

package/dist/api/routes/public/utils/Endpoint.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Endpoint {
+    constructor(method, url, controller) {
+        this.method = method;
+        this.url = url;
+        this.controller = controller;
+        this.middlewares = [];
+        this.outputMiddlewares = [];
+    }
+    addMiddleware(middleware) {
+        this.middlewares.push(middleware);
+        return this;
+    }
+    addOutputMiddleware(middleware) {
+        this.outputMiddlewares.push(middleware);
+        return this;
+    }
+    apply(router) {
+        const method = this.method, url = this.url;
+        const middlewares = this.middlewares, controller = this.controller, outputMiddlewares = this.outputMiddlewares;
+        // need a function to do nothing to stop the execution at the end
+        // middlewares are circular so if they always keep calling next, it'll just keep looping
+        const complete = () => { };
+        const params = [
+            url,
+            ...middlewares,
+            controller,
+            ...outputMiddlewares,
+            complete,
+        ];
+        // @ts-ignore
+        router[method](...params);
+    }
+}
+exports.default = Endpoint;

package/dist/api/routes/role.js

@@ -2,27 +2,11 @@
 const Router = require("@koa/router");
 const controller = require("../controllers/role");
 const authorized = require("../../middleware/authorized");
-const Joi = require("joi");
-const joiValidator = require("../../middleware/joi-validator");
-const { BUILTIN_PERMISSION_IDS, BUILDER, PermissionLevels, } = require("@budibase/backend-core/permissions");
+const { BUILDER } = require("@budibase/backend-core/permissions");
+const { roleValidator } = require("./utils/validators");
 const router = Router();
-function generateValidator() {
-    const permLevelArray = Object.values(PermissionLevels);
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        _id: Joi.string().optional(),
-        _rev: Joi.string().optional(),
-        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: Joi.string().optional(),
-    }).unknown(true));
-}
 router
-    .post("/api/roles", authorized(BUILDER), generateValidator(), controller.save)
+    .post("/api/roles", authorized(BUILDER), roleValidator(), controller.save)
     .get("/api/roles", authorized(BUILDER), controller.fetch)
     .get("/api/roles/:roleId", authorized(BUILDER), controller.find)
     .delete("/api/roles/:roleId/:rev", authorized(BUILDER), controller.destroy);

package/dist/api/routes/row.js

@@ -5,6 +5,7 @@ const authorized = require("../../middleware/authorized");
 const usage = require("../../middleware/usageQuota");
 const { paramResource, paramSubResource, } = require("../../middleware/resourceId");
 const { PermissionLevels, PermissionTypes, } = require("@budibase/backend-core/permissions");
+const { internalSearchValidator } = require("./utils/validators");
 const router = Router();
 router
     /**
@@ -97,8 +98,6 @@ router
      *    "notEqual": {},
      *    "empty": {},
      *    "notEmpty": {},
-     *    "contains": {},
-     *    "notContains": {}
      *    "oneOf": {
      *      "columnName": ["value"]
      *    }
@@ -116,7 +115,7 @@ router
      * @apiSuccess {string} bookmark The bookmark to be sent with the next request to get the next
      * page.
      */
-    .post("/api/:tableId/search", paramResource("tableId"), authorized(PermissionTypes.TABLE, PermissionLevels.READ), rowController.search)
+    .post("/api/:tableId/search", internalSearchValidator(), paramResource("tableId"), authorized(PermissionTypes.TABLE, PermissionLevels.READ), rowController.search)
     // DEPRECATED - this is an old API, but for backwards compat it needs to be
     // supported still
     .post("/api/search/:tableId/rows", paramResource("tableId"), authorized(PermissionTypes.TABLE, PermissionLevels.READ), rowController.search)
@@ -153,7 +152,7 @@ router
      * @apiDescription This endpoint is identical to the row creation endpoint but instead it will
      * error if an _id isn't provided, it will only function for existing rows.
      */
-    .patch("/api/:tableId/rows", paramResource("tableId"), authorized(PermissionTypes.TABLE, PermissionLevels.WRITE), rowController.patch)
+    .patch("/api/:tableId/rows", paramResource("tableId"), authorized(PermissionTypes.TABLE, PermissionLevels.WRITE), usage, rowController.patch)
     /**
      * @api {post} /api/:tableId/rows/validate Validate inputs for a row
      * @apiName Validate inputs for a row

package/dist/api/routes/screen.js

@@ -3,31 +3,10 @@ const Router = require("@koa/router");
 const controller = require("../controllers/screen");
 const authorized = require("../../middleware/authorized");
 const { BUILDER } = require("@budibase/backend-core/permissions");
-const joiValidator = require("../../middleware/joi-validator");
-const Joi = require("joi");
+const { screenValidator } = require("./utils/validators");
 const router = Router();
-function generateSaveValidation() {
-    // 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: Joi.string().optional(),
-            table: Joi.string().optional(),
-            layoutId: Joi.string().optional(),
-        }).required().unknown(true),
-    }).unknown(true));
-}
 router
     .get("/api/screens", authorized(BUILDER), controller.fetch)
-    .post("/api/screens", authorized(BUILDER), generateSaveValidation(), controller.save)
+    .post("/api/screens", authorized(BUILDER), screenValidator(), controller.save)
     .delete("/api/screens/:screenId/:screenRev", authorized(BUILDER), controller.destroy);
 module.exports = router;