@budibase/server 1.3.21 → 1.3.22-alpha.1

package/dist/api/controllers/screen.js

@@ -8,40 +8,88 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-const { getScreenParams, generateScreenID } = require("../../db/utils");
-const { AccessController } = require("@budibase/backend-core/roles");
-const { getAppDB } = require("@budibase/backend-core/context");
-const { events } = require("@budibase/backend-core");
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../../db/utils");
+const backend_core_1 = require("@budibase/backend-core");
+const application_1 = require("./application");
 exports.fetch = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
-    const db = getAppDB();
-    const screens = (yield db.allDocs(getScreenParams(null, {
+    const db = backend_core_1.context.getAppDB();
+    const screens = (yield db.allDocs((0, utils_1.getScreenParams)(null, {
         include_docs: true,
-    }))).rows.map(element => element.doc);
-    ctx.body = yield new AccessController().checkScreensAccess(screens, ctx.user.role._id);
+    }))).rows.map((el) => el.doc);
+    ctx.body = yield new backend_core_1.roles.AccessController().checkScreensAccess(screens, ctx.user.role._id);
 });
 exports.save = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
-    const db = getAppDB();
+    const db = backend_core_1.context.getAppDB();
     let screen = ctx.request.body;
     let eventFn;
     if (!screen._id) {
-        screen._id = generateScreenID();
-        eventFn = events.screen.created;
+        screen._id = (0, utils_1.generateScreenID)();
+        eventFn = backend_core_1.events.screen.created;
     }
     const response = yield db.put(screen);
+    // Find any custom components being used
+    let pluginNames = [];
+    let pluginAdded = false;
+    findPlugins(screen.props, pluginNames);
+    if (pluginNames.length) {
+        const globalDB = backend_core_1.tenancy.getGlobalDB();
+        const pluginsResponse = yield globalDB.allDocs(backend_core_1.db.getPluginParams(null, {
+            include_docs: true,
+        }));
+        const requiredPlugins = pluginsResponse.rows
+            .map((row) => row.doc)
+            .filter((plugin) => {
+            return (plugin.schema.type === "component" &&
+                pluginNames.includes(`plugin/${plugin.name}`));
+        });
+        // Update the app metadata
+        const application = yield db.get(utils_1.DocumentType.APP_METADATA);
+        let usedPlugins = application.usedPlugins || [];
+        requiredPlugins.forEach((plugin) => {
+            if (!usedPlugins.find((x) => x._id === plugin._id)) {
+                pluginAdded = true;
+                usedPlugins.push({
+                    _id: plugin._id,
+                    name: plugin.name,
+                    version: plugin.version,
+                    jsUrl: plugin.jsUrl,
+                    hash: plugin.hash,
+                });
+            }
+        });
+        if (pluginAdded) {
+            yield (0, application_1.updateAppPackage)({ usedPlugins }, ctx.appId);
+        }
+    }
     if (eventFn) {
         yield eventFn(screen);
     }
     ctx.message = `Screen ${screen.name} saved.`;
-    ctx.body = Object.assign(Object.assign({}, screen), { _id: response.id, _rev: response.rev });
+    ctx.body = Object.assign(Object.assign({}, screen), { _id: response.id, _rev: response.rev, pluginAdded });
 });
 exports.destroy = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
-    const db = getAppDB();
+    const db = backend_core_1.context.getAppDB();
     const id = ctx.params.screenId;
     const screen = yield db.get(id);
     yield db.remove(id, ctx.params.screenRev);
-    yield events.screen.deleted(screen);
+    yield backend_core_1.events.screen.deleted(screen);
     ctx.body = {
         message: "Screen deleted successfully",
     };
     ctx.status = 200;
 });
+const findPlugins = (component, foundPlugins) => {
+    if (!component) {
+        return;
+    }
+    if (component._component.startsWith("plugin")) {
+        if (!foundPlugins.includes(component._component)) {
+            foundPlugins.push(component._component);
+        }
+    }
+    if (!component._children || !component._children.length) {
+        return;
+    }
+    component._children.forEach(child => findPlugins(child, foundPlugins));
+};

package/dist/api/controllers/static/index.js

@@ -113,6 +113,7 @@ const serveApp = function (ctx) {
                 production: env.isProd(),
                 appId,
                 clientLibPath: clientLibraryPath(appId, appInfo.version, ctx),
+                usedPlugins: appInfo.usedPlugins,
             });
             const appHbs = loadHandlebarsFile(`${__dirname}/templates/app.hbs`);
             ctx.body = yield processString(appHbs, {

package/dist/api/controllers/static/templates/BudibaseApp.svelte

@@ -3,6 +3,7 @@
   export let favicon = ""
 
   export let clientLibPath
+  export let usedPlugins
 </script>
 
 <svelte:head>
@@ -83,6 +84,15 @@
   </script>
   <script type="application/javascript" src={clientLibPath}>
   </script>
+  <!-- Custom components need inserted after the core client library -->
+  <!-- But before loadBudibase is called -->
+  {#if usedPlugins?.length}
+    {#each usedPlugins as plugin}
+      <script
+        type="application/javascript"
+        src={`/plugins/${plugin.jsUrl}`}></script>
+    {/each}
+  {/if}
   <script type="application/javascript">
     if (window.loadBudibase) {
       window.loadBudibase()

package/dist/api/controllers/static/templates/preview.hbs

@@ -66,7 +66,9 @@
         customTheme,
         previewDevice,
         navigation,
-        hiddenComponentIds
+        hiddenComponentIds,
+        usedPlugins,
+        location
       } = parsed
 
       // Set some flags so the app knows we're in the builder
@@ -81,6 +83,8 @@
       window["##BUDIBASE_PREVIEW_DEVICE##"] = previewDevice
       window["##BUDIBASE_PREVIEW_NAVIGATION##"] = navigation
       window["##BUDIBASE_HIDDEN_COMPONENT_IDS##"] = hiddenComponentIds
+      window["##BUDIBASE_USED_PLUGINS##"] = usedPlugins
+      window["##BUDIBASE_LOCATION##"] = location
 
       // Initialise app
       try {

package/dist/api/index.js

@@ -51,8 +51,8 @@ router
     .use(buildTenancyMiddleware(null, null, {
     noTenancyRequired: true,
 }))
-    .use(currentApp)
     .use(pro.licensing())
+    .use(currentApp)
     .use(auditLog);
 // error handling middleware
 router.use((ctx, next) => __awaiter(void 0, void 0, void 0, function* () {

package/dist/api/routes/application.js

@@ -30,14 +30,15 @@ const router_1 = __importDefault(require("@koa/router"));
 const controller = __importStar(require("../controllers/application"));
 const authorized_1 = __importDefault(require("../../middleware/authorized"));
 const permissions_1 = require("@budibase/backend-core/permissions");
+const validators_1 = require("./utils/validators");
 const router = new router_1.default();
 router
     .post("/api/applications/:appId/sync", (0, authorized_1.default)(permissions_1.BUILDER), controller.sync)
-    .post("/api/applications", (0, authorized_1.default)(permissions_1.BUILDER), controller.create)
+    .post("/api/applications", (0, authorized_1.default)(permissions_1.BUILDER), (0, validators_1.applicationValidator)(), controller.create)
     .get("/api/applications/:appId/definition", controller.fetchAppDefinition)
     .get("/api/applications", controller.fetch)
     .get("/api/applications/:appId/appPackage", controller.fetchAppPackage)
-    .put("/api/applications/:appId", (0, authorized_1.default)(permissions_1.BUILDER), controller.update)
+    .put("/api/applications/:appId", (0, authorized_1.default)(permissions_1.BUILDER), (0, validators_1.applicationValidator)({ isCreate: false }), controller.update)
     .post("/api/applications/:appId/client/update", (0, authorized_1.default)(permissions_1.BUILDER), controller.updateClient)
     .post("/api/applications/:appId/client/revert", (0, authorized_1.default)(permissions_1.BUILDER), controller.revertClient)
     .delete("/api/applications/:appId", (0, authorized_1.default)(permissions_1.BUILDER), controller.destroy);

package/dist/api/routes/index.js

@@ -30,6 +30,7 @@ const metadata_1 = __importDefault(require("./metadata"));
 const dev_1 = __importDefault(require("./dev"));
 const cloud_1 = __importDefault(require("./cloud"));
 const migrations_1 = __importDefault(require("./migrations"));
+const plugin_1 = __importDefault(require("./plugin"));
 var static_1 = require("./static");
 Object.defineProperty(exports, "staticRoutes", { enumerable: true, get: function () { return __importDefault(static_1).default; } });
 var public_1 = require("./public");
@@ -63,4 +64,5 @@ exports.mainRoutes = [
     table_1.default,
     row_1.default,
     migrations_1.default,
+    plugin_1.default,
 ];

package/dist/{migrations/functions/publishedAppsQuota.js → api/routes/plugin.js}

@@ -22,26 +22,18 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-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 });
-exports.run = void 0;
-const syncPublishedApps = __importStar(require("./usageQuotas/syncPublishedApps"));
-/**
- * Date:
- * March 2022
- *
- * Description:
- * Sync the published apps count
- */
-const run = (db) => __awaiter(void 0, void 0, void 0, function* () {
-    yield syncPublishedApps.run();
-});
-exports.run = run;
+const router_1 = __importDefault(require("@koa/router"));
+const controller = __importStar(require("../controllers/plugin"));
+const authorized_1 = __importDefault(require("../../middleware/authorized"));
+const permissions_1 = require("@budibase/backend-core/permissions");
+const router = new router_1.default();
+router
+    .post("/api/plugin/upload", (0, authorized_1.default)(permissions_1.BUILDER), controller.upload)
+    .post("/api/plugin", (0, authorized_1.default)(permissions_1.BUILDER), controller.create)
+    .get("/api/plugin", (0, authorized_1.default)(permissions_1.BUILDER), controller.fetch)
+    .delete("/api/plugin/:pluginId", (0, authorized_1.default)(permissions_1.BUILDER), controller.destroy);
+exports.default = router;

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

@@ -137,88 +137,7 @@ read.push(new Endpoint_1.default("get", "/tables/:tableId/rows/:rowId", rows_1.d
  *       content:
  *         application/json:
  *           schema:
- *             type: object
- *             required:
- *               - query
- *             properties:
- *               query:
- *                 type: object
- *                 properties:
- *                   allOr:
- *                     type: boolean
- *                     description: Specifies that a row should be returned if it satisfies
- *                       any of the specified options, rather than requiring it to fulfill all
- *                       the search parameters. This defaults to false, meaning AND logic will be used.
- *                   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
- *                       in the format of an object with a "low" and "high" property.
- *                     example:
- *                       columnName1: { low: 10, high: 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.
+ *             $ref: '#/components/schemas/rowSearch'
  *     responses:
  *       200:
  *         description: The response will contain an array of rows that match the search parameters.

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

@@ -28,7 +28,7 @@ const read = [], write = [];
  *     responses:
  *       200:
  *         description: Returns the created table, including the ID which has been generated for it. This can be
- *           internal or external data sources.
+ *           internal or external datasources.
  *         content:
  *           application/json:
  *             schema:

package/dist/api/routes/table.js

@@ -45,7 +45,7 @@ router
      * @apiParam (Body) {string} [_rev] If updating an existing internal table then the revision must also be specified.
      * @apiParam (Body) {string} type] This should either be "internal" or "external" depending on the table type -
      * this will default to internal.
-     * @apiParam (Body) {string} [sourceId] If creating an external table then this should be set to the data source ID. If
+     * @apiParam (Body) {string} [sourceId] If creating an external table then this should be set to the datasource ID. If
      * building an internal table this does not need to be set, although it will be returned as "bb_internal".
      * @apiParam (Body) {string} name The name of the table, this will be used in the UI. To rename the table simply
      * supply the table structure to this endpoint with the name changed.

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

@@ -7,6 +7,7 @@ const Joi = require("joi");
 const OPTIONAL_STRING = Joi.string().optional().allow(null).allow("");
 const OPTIONAL_NUMBER = Joi.number().optional().allow(null);
 const OPTIONAL_BOOLEAN = Joi.boolean().optional().allow(null);
+const APP_NAME_REGEX = /^[\w\s]+$/;
 exports.tableValidator = () => {
     // prettier-ignore
     return joiValidator.body(Joi.object({
@@ -190,12 +191,29 @@ exports.automationValidator = (existing = false) => {
         }).required().unknown(true),
     }).unknown(true));
 };
-exports.applicationValidator = () => {
+exports.applicationValidator = (opts = { isCreate: true }) => {
     // prettier-ignore
+    const base = {
+        _id: OPTIONAL_STRING,
+        _rev: OPTIONAL_STRING,
+        url: OPTIONAL_STRING,
+        template: Joi.object({
+            templateString: OPTIONAL_STRING,
+        })
+    };
+    const appNameValidator = Joi.string()
+        .pattern(new RegExp(APP_NAME_REGEX))
+        .error(new Error("App name must be letters, numbers and spaces only"));
+    if (opts.isCreate) {
+        base.name = appNameValidator.required();
+    }
+    else {
+        base.name = appNameValidator.optional();
+    }
     return joiValidator.body(Joi.object({
         _id: OPTIONAL_STRING,
         _rev: OPTIONAL_STRING,
-        name: Joi.string().required(),
+        name: appNameValidator,
         url: OPTIONAL_STRING,
         template: Joi.object({
             templateString: OPTIONAL_STRING,

package/dist/app.js

@@ -60,10 +60,13 @@ const bullboard = require("./automations/bullboard");
 const { logAlert } = require("@budibase/backend-core/logging");
 const { pinoSettings } = require("@budibase/backend-core");
 const { Thread } = require("./threads");
+const fs = require("fs");
 const redis_1 = __importDefault(require("./utilities/redis"));
 const migrations = __importStar(require("./migrations"));
 const backend_core_1 = require("@budibase/backend-core");
 const workerRequests_1 = require("./utilities/workerRequests");
+const watch_1 = require("./watch");
+const websocket_1 = require("./websocket");
 const app = new Koa();
 // set up top level koa middleware
 app.use(koaBody({
@@ -97,6 +100,7 @@ if (env.isProd()) {
 }
 const server = http.createServer(app.callback());
 destroyable(server);
+(0, websocket_1.initialise)(server);
 let shuttingDown = false, errCode = 0;
 server.on("close", () => __awaiter(void 0, void 0, void 0, function* () {
     // already in process
@@ -141,7 +145,11 @@ module.exports = server.listen(env.PORT || 0, () => __awaiter(void 0, void 0, vo
         if (!((_a = checklist === null || checklist === void 0 ? void 0 : checklist.adminUser) === null || _a === void 0 ? void 0 : _a.checked)) {
             try {
                 const tenantId = backend_core_1.tenancy.getTenantId();
-                yield (0, workerRequests_1.createAdminUser)(env.BB_ADMIN_USER_EMAIL, env.BB_ADMIN_USER_PASSWORD, tenantId);
+                const user = yield (0, workerRequests_1.createAdminUser)(env.BB_ADMIN_USER_EMAIL, env.BB_ADMIN_USER_PASSWORD, tenantId);
+                // Need to set up an API key for automated integration tests
+                if (env.isTest()) {
+                    yield (0, workerRequests_1.generateApiKey)(user._id);
+                }
                 console.log("Admin account automatically created for", env.BB_ADMIN_USER_EMAIL);
             }
             catch (e) {
@@ -150,6 +158,13 @@ module.exports = server.listen(env.PORT || 0, () => __awaiter(void 0, void 0, vo
             }
         }
     }
+    // monitor plugin directory if required
+    if (env.SELF_HOSTED &&
+        !env.MULTI_TENANCY &&
+        env.PLUGINS_DIR &&
+        fs.existsSync(env.PLUGINS_DIR)) {
+        (0, watch_1.watch)();
+    }
     // check for version updates
     yield backend_core_1.installation.checkInstallVersion();
     // done last - this will never complete

package/dist/db/utils.js

@@ -274,6 +274,9 @@ exports.generateMemoryViewID = viewName => {
 exports.getMemoryViewParams = (otherProps = {}) => {
     return getDocParams(DocumentType.MEM_VIEW, null, otherProps);
 };
+exports.generatePluginID = name => {
+    return `${DocumentType.PLUGIN}${SEPARATOR}${name}`;
+};
 /**
  * This can be used with the db.allDocs to get a list of IDs
  */

package/dist/environment.js

@@ -64,6 +64,7 @@ module.exports = {
     SQL_MAX_ROWS: process.env.SQL_MAX_ROWS,
     BB_ADMIN_USER_EMAIL: process.env.BB_ADMIN_USER_EMAIL,
     BB_ADMIN_USER_PASSWORD: process.env.BB_ADMIN_USER_PASSWORD,
+    PLUGINS_DIR: process.env.PLUGINS_DIR || "/plugins",
     // flags
     ALLOW_DEV_AUTOMATIONS: process.env.ALLOW_DEV_AUTOMATIONS,
     DISABLE_THREADING: process.env.DISABLE_THREADING,