@budibase/server 2.6.23 → 2.6.24-alpha.1

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

@@ -1,72 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const queries_1 = __importDefault(require("../../controllers/public/queries"));
-const Endpoint_1 = __importDefault(require("./utils/Endpoint"));
-const validators_1 = require("../utils/validators");
-const read = [], write = [];
-/**
- * @openapi
- * /queries/{queryId}:
- *   post:
- *     operationId: queryExecute
- *     summary: Execute a query
- *     description: Queries which have been created within a Budibase app can be executed using this,
- *     tags:
- *       - queries
- *     parameters:
- *       - $ref: '#/components/parameters/queryId'
- *       - $ref: '#/components/parameters/appId'
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/executeQuery'
- *     responses:
- *       200:
- *         description: Returns the result of the query execution.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/executeQueryOutput'
- *             examples:
- *               REST:
- *                 $ref: '#/components/examples/restResponse'
- *               SQL:
- *                 $ref: '#/components/examples/sqlResponse'
- *
- */
-write.push(new Endpoint_1.default("post", "/queries/:queryId", queries_1.default.execute));
-/**
- * @openapi
- * /queries/search:
- *   post:
- *     operationId: querySearch
- *     summary: Search for queries
- *     description: Based on query properties (currently only name) search for queries.
- *     tags:
- *       - queries
- *     parameters:
- *       - $ref: '#/components/parameters/appId'
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/nameSearch'
- *     responses:
- *       200:
- *         description: Returns the queries found based on the search parameters.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/querySearch'
- *             examples:
- *               queries:
- *                 $ref: '#/components/examples/queries'
- */
-read.push(new Endpoint_1.default("post", "/queries/search", queries_1.default.search).addMiddleware((0, validators_1.nameValidator)()));
-exports.default = { read, write };

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

@@ -1,158 +0,0 @@
-"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:
- *     operationId: rowCreate
- *     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:
- *     operationId: rowUpdate
- *     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:
- *     operationId: rowDestroy
- *     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:
- *     operationId: rowGetById
- *     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:
- *     operationId: rowSearch
- *     summary: Search for rows
- *     tags:
- *       - rows
- *     parameters:
- *       - $ref: '#/components/parameters/tableId'
- *       - $ref: '#/components/parameters/appId'
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/rowSearch'
- *     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((0, validators_1.externalSearchValidator)()));
-exports.default = { read, write };

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

@@ -1,152 +0,0 @@
-"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:
- *     operationId: tableCreate
- *     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 datasources.
- *         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((0, validators_1.tableValidator)()));
-/**
- * @openapi
- * /tables/{tableId}:
- *   put:
- *     operationId: tableUpdate
- *     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((0, validators_1.tableValidator)()));
-/**
- * @openapi
- * /tables/{tableId}:
- *   delete:
- *     operationId: tableDestroy
- *     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:
- *     operationId: tableGetById
- *     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:
- *     operationId: tableSearch
- *     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:
- *               $ref: '#/components/schemas/tableSearch'
- *             examples:
- *               tables:
- *                 $ref: '#/components/examples/tables'
- */
-read.push(new Endpoint_1.default("post", "/tables/search", tables_1.default.search).addMiddleware((0, validators_1.nameValidator)()));
-exports.default = { read, write };

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

@@ -1,135 +0,0 @@
-"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:
- *     operationId: userCreate
- *     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:
- *     operationId: userUpdate
- *     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:
- *     operationId: userDestroy
- *     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:
- *     operationId: userGetById
- *     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:
- *     operationId: userSearch
- *     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:
- *               $ref: '#/components/schemas/userSearch'
- *             examples:
- *               users:
- *                 $ref: '#/components/examples/users'
- */
-read.push(new Endpoint_1.default("post", "/users/search", users_1.default.search).addMiddleware((0, validators_1.nameValidator)()));
-exports.default = { read, write };

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

@@ -1,36 +0,0 @@
-"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/query.js

@@ -1,47 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const router_1 = __importDefault(require("@koa/router"));
-const queryController = __importStar(require("../controllers/query"));
-const authorized_1 = __importDefault(require("../../middleware/authorized"));
-const backend_core_1 = require("@budibase/backend-core");
-const resourceId_1 = require("../../middleware/resourceId");
-const validation_1 = require("../controllers/query/validation");
-const { BUILDER, PermissionType, PermissionLevel } = backend_core_1.permissions;
-const router = new router_1.default();
-router
-    .get("/api/queries", (0, authorized_1.default)(BUILDER), queryController.fetch)
-    .post("/api/queries", (0, resourceId_1.bodySubResource)("datasourceId", "_id"), (0, authorized_1.default)(BUILDER), (0, validation_1.generateQueryValidation)(), queryController.save)
-    .post("/api/queries/import", (0, authorized_1.default)(BUILDER), queryController.import)
-    .post("/api/queries/preview", (0, resourceId_1.bodyResource)("datasourceId"), (0, authorized_1.default)(BUILDER), (0, validation_1.generateQueryPreviewValidation)(), queryController.preview)
-    .get("/api/queries/:queryId", (0, resourceId_1.paramResource)("queryId"), (0, authorized_1.default)(PermissionType.QUERY, PermissionLevel.READ), queryController.find)
-    // DEPRECATED - use new query endpoint for future work
-    .post("/api/queries/:queryId", (0, resourceId_1.paramResource)("queryId"), (0, authorized_1.default)(PermissionType.QUERY, PermissionLevel.WRITE), queryController.executeV1)
-    .delete("/api/queries/:queryId/:revId", (0, resourceId_1.paramResource)("queryId"), (0, authorized_1.default)(BUILDER), queryController.destroy)
-    .post("/api/v2/queries/:queryId", (0, resourceId_1.paramResource)("queryId"), (0, authorized_1.default)(PermissionType.QUERY, PermissionLevel.WRITE), queryController.executeV2);
-exports.default = router;

package/dist/api/routes/role.js

@@ -1,40 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const router_1 = __importDefault(require("@koa/router"));
-const controller = __importStar(require("../controllers/role"));
-const authorized_1 = __importDefault(require("../../middleware/authorized"));
-const backend_core_1 = require("@budibase/backend-core");
-const validators_1 = require("./utils/validators");
-const router = new router_1.default();
-router
-    .post("/api/roles", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), (0, validators_1.roleValidator)(), controller.save)
-    .get("/api/roles", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), controller.fetch)
-    .get("/api/roles/:roleId", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), controller.find)
-    .delete("/api/roles/:roleId/:rev", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), controller.destroy);
-exports.default = router;

package/dist/api/routes/routing.js

@@ -1,39 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const router_1 = __importDefault(require("@koa/router"));
-const authorized_1 = __importDefault(require("../../middleware/authorized"));
-const backend_core_1 = require("@budibase/backend-core");
-const controller = __importStar(require("../controllers/routing"));
-const router = new router_1.default();
-router
-    // gets correct structure for user role
-    .get("/api/routing/client", controller.clientFetch)
-    // gets the full structure, not just the correct screen ID for user role
-    .get("/api/routing", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), controller.fetch);
-exports.default = router;