@budibase/server 1.0.80-alpha.3 → 1.0.80

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

@@ -1,141 +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 applications_1 = __importDefault(require("../../controllers/public/applications"));
-const Endpoint_1 = __importDefault(require("./utils/Endpoint"));
-const { nameValidator, applicationValidator } = require("../utils/validators");
-const read = [], write = [];
-/**
- * @openapi
- * /applications:
- *   post:
- *     summary: Create an application
- *     tags:
- *       - applications
- *     parameters:
- *       - $ref: '#/components/parameters/appId'
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/application'
- *     responses:
- *       200:
- *         description: Returns the created application.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/applicationOutput'
- *             examples:
- *               application:
- *                 $ref: '#/components/examples/application'
- */
-write.push(new Endpoint_1.default("post", "/applications", applications_1.default.create).addMiddleware(applicationValidator()));
-/**
- * @openapi
- * /applications/{appId}:
- *   put:
- *     summary: Update an application
- *     tags:
- *       - applications
- *     parameters:
- *       - $ref: '#/components/parameters/appIdUrl'
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/application'
- *     responses:
- *       200:
- *         description: Returns the updated application.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/applicationOutput'
- *             examples:
- *               application:
- *                 $ref: '#/components/examples/application'
- */
-write.push(new Endpoint_1.default("put", "/applications/:appId", applications_1.default.update).addMiddleware(applicationValidator()));
-/**
- * @openapi
- * /applications/{appId}:
- *   delete:
- *     summary: Delete an application
- *     tags:
- *       - applications
- *     parameters:
- *       - $ref: '#/components/parameters/appIdUrl'
- *     responses:
- *       200:
- *         description: Returns the deleted application.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/applicationOutput'
- *             examples:
- *               application:
- *                 $ref: '#/components/examples/application'
- */
-write.push(new Endpoint_1.default("delete", "/applications/:appId", applications_1.default.destroy));
-/**
- * @openapi
- * /applications/{appId}:
- *   get:
- *     summary: Retrieve an application
- *     tags:
- *       - applications
- *     parameters:
- *       - $ref: '#/components/parameters/appIdUrl'
- *     responses:
- *       200:
- *         description: Returns the retrieved application.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/applicationOutput'
- *             examples:
- *               application:
- *                 $ref: '#/components/examples/application'
- */
-read.push(new Endpoint_1.default("get", "/applications/:appId", applications_1.default.read));
-/**
- * @openapi
- * /applications/search:
- *   post:
- *     summary: Search for applications
- *     description: Based on application properties (currently only name) search for applications.
- *     tags:
- *       - applications
- *     parameters:
- *       - $ref: '#/components/parameters/appId'
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/nameSearch'
- *     responses:
- *       200:
- *         description: Returns the applications that were found based on the search parameters.
- *         content:
- *           application/json:
- *             schema:
- *               type: object
- *               required:
- *                 - data
- *               properties:
- *                 data:
- *                   type: array
- *                   items:
- *                     $ref: '#/components/schemas/application'
- *             examples:
- *               applications:
- *                 $ref: '#/components/examples/applications'
- */
-read.push(new Endpoint_1.default("post", "/applications/search", applications_1.default.search).addMiddleware(nameValidator()));
-exports.default = { read, write };

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

@@ -1,101 +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 applications_1 = __importDefault(require("./applications"));
-const queries_1 = __importDefault(require("./queries"));
-const tables_1 = __importDefault(require("./tables"));
-const rows_1 = __importDefault(require("./rows"));
-const users_1 = __importDefault(require("./users"));
-const usageQuota_1 = __importDefault(require("../../../middleware/usageQuota"));
-const authorized_1 = __importDefault(require("../../../middleware/authorized"));
-const resourceId_1 = require("../../../middleware/resourceId");
-const mapper_1 = __importDefault(require("./middleware/mapper"));
-const environment_1 = __importDefault(require("../../../environment"));
-// below imports don't have declaration files
-const Router = require("@koa/router");
-const { RateLimit, Stores } = require("koa2-ratelimit");
-const { PermissionLevels, PermissionTypes, } = require("@budibase/backend-core/permissions");
-const { getRedisOptions } = require("@budibase/backend-core/redis").utils;
-const PREFIX = "/api/public/v1";
-// allow a lot more requests when in test
-const DEFAULT_API_REQ_LIMIT_PER_SEC = environment_1.default.isTest() ? 100 : 10;
-function getApiLimitPerSecond() {
-    if (!environment_1.default.API_REQ_LIMIT_PER_SEC) {
-        return DEFAULT_API_REQ_LIMIT_PER_SEC;
-    }
-    return parseInt(environment_1.default.API_REQ_LIMIT_PER_SEC);
-}
-if (!environment_1.default.isTest()) {
-    const REDIS_OPTS = getRedisOptions();
-    RateLimit.defaultOptions({
-        store: new Stores.Redis({
-            // @ts-ignore
-            socket: {
-                host: REDIS_OPTS.host,
-                port: REDIS_OPTS.port,
-            },
-            password: REDIS_OPTS.opts.password,
-            database: 1,
-        }),
-    });
-}
-// rate limiting, allows for 2 requests per second
-const limiter = RateLimit.middleware({
-    interval: { sec: 1 },
-    // per ip, per interval
-    max: getApiLimitPerSecond(),
-});
-const publicRouter = new Router({
-    prefix: PREFIX,
-});
-publicRouter.use(limiter);
-function addMiddleware(endpoints, middleware, opts = { output: false }) {
-    if (!endpoints) {
-        return;
-    }
-    if (!Array.isArray(endpoints)) {
-        endpoints = [endpoints];
-    }
-    for (let endpoint of endpoints) {
-        if (opts === null || opts === void 0 ? void 0 : opts.output) {
-            endpoint.addOutputMiddleware(middleware);
-        }
-        else {
-            endpoint.addMiddleware(middleware);
-        }
-    }
-}
-function addToRouter(endpoints) {
-    if (endpoints) {
-        for (let endpoint of endpoints) {
-            endpoint.apply(publicRouter);
-        }
-    }
-}
-function applyRoutes(endpoints, permType, resource, subResource) {
-    const paramMiddleware = subResource
-        ? resourceId_1.paramSubResource(resource, subResource)
-        : resourceId_1.paramResource(resource);
-    // add the parameter capture middleware
-    addMiddleware(endpoints.read, paramMiddleware);
-    addMiddleware(endpoints.write, paramMiddleware);
-    // add the authorization middleware, using the correct perm type
-    addMiddleware(endpoints.read, authorized_1.default(permType, PermissionLevels.READ));
-    addMiddleware(endpoints.write, authorized_1.default(permType, PermissionLevels.WRITE));
-    // add the usage quota middleware
-    addMiddleware(endpoints.write, usageQuota_1.default);
-    // add the output mapper middleware
-    addMiddleware(endpoints.read, mapper_1.default, { output: true });
-    addMiddleware(endpoints.write, mapper_1.default, { output: true });
-    addToRouter(endpoints.read);
-    addToRouter(endpoints.write);
-}
-applyRoutes(applications_1.default, PermissionTypes.APP, "appId");
-applyRoutes(tables_1.default, PermissionTypes.TABLE, "tableId");
-applyRoutes(users_1.default, PermissionTypes.USER, "userId");
-applyRoutes(queries_1.default, PermissionTypes.QUERY, "queryId");
-// needs to be applied last for routing purposes, don't override other endpoints
-applyRoutes(rows_1.default, PermissionTypes.TABLE, "tableId", "rowId");
-module.exports = publicRouter;

package/dist/api/routes/public/middleware/mapper.js

@@ -1,94 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const mapping_1 = __importDefault(require("../../../controllers/public/mapping"));
-var Resources;
-(function (Resources) {
-    Resources["APPLICATION"] = "applications";
-    Resources["TABLES"] = "tables";
-    Resources["ROWS"] = "rows";
-    Resources["USERS"] = "users";
-    Resources["QUERIES"] = "queries";
-    Resources["SEARCH"] = "search";
-})(Resources || (Resources = {}));
-function isArrayResponse(ctx) {
-    return ctx.url.endsWith(Resources.SEARCH) || Array.isArray(ctx.body);
-}
-function processApplications(ctx) {
-    if (isArrayResponse(ctx)) {
-        return mapping_1.default.mapApplications(ctx);
-    }
-    else {
-        return mapping_1.default.mapApplication(ctx);
-    }
-}
-function processTables(ctx) {
-    if (isArrayResponse(ctx)) {
-        return mapping_1.default.mapTables(ctx);
-    }
-    else {
-        return mapping_1.default.mapTable(ctx);
-    }
-}
-function processRows(ctx) {
-    if (isArrayResponse(ctx)) {
-        return mapping_1.default.mapRowSearch(ctx);
-    }
-    else {
-        return mapping_1.default.mapRow(ctx);
-    }
-}
-function processUsers(ctx) {
-    if (isArrayResponse(ctx)) {
-        return mapping_1.default.mapUsers(ctx);
-    }
-    else {
-        return mapping_1.default.mapUser(ctx);
-    }
-}
-function processQueries(ctx) {
-    if (isArrayResponse(ctx)) {
-        return mapping_1.default.mapQueries(ctx);
-    }
-    else {
-        return mapping_1.default.mapQueryExecution(ctx);
-    }
-}
-exports.default = (ctx, next) => __awaiter(void 0, void 0, void 0, function* () {
-    let urlParts = ctx.url.split("/");
-    urlParts = urlParts.slice(4, urlParts.length);
-    let body = {};
-    switch (urlParts[0]) {
-        case Resources.APPLICATION:
-            body = processApplications(ctx);
-            break;
-        case Resources.TABLES:
-            if (urlParts[2] === Resources.ROWS) {
-                body = processRows(ctx);
-            }
-            else {
-                body = processTables(ctx);
-            }
-            break;
-        case Resources.USERS:
-            body = processUsers(ctx);
-            break;
-        case Resources.QUERIES:
-            body = processQueries(ctx);
-            break;
-    }
-    // update the body based on what has occurred in the mapper
-    ctx.body = body;
-    yield next();
-});

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

@@ -1,77 +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:
- *     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:
- *     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:
- *               type: object
- *               required:
- *                 - data
- *               properties:
- *                 data:
- *                   type: array
- *                   items:
- *                     $ref: '#/components/schemas/query'
- *             examples:
- *               queries:
- *                 $ref: '#/components/examples/queries'
- */
-read.push(new Endpoint_1.default("post", "/queries/search", queries_1.default.search).addMiddleware(validators_1.nameValidator()));
-exports.default = { read, write };

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

@@ -1,229 +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:
- *     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 };