@budibase/server 1.3.18 → 1.3.19-alpha.0

package/dist/api/controllers/screen.js

@@ -8,10 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-const { getScreenParams, generateScreenID } = require("../../db/utils");
+const { getScreenParams, generateScreenID, getPluginParams, DocumentType, } = require("../../db/utils");
 const { AccessController } = require("@budibase/backend-core/roles");
 const { getAppDB } = require("@budibase/backend-core/context");
 const { events } = require("@budibase/backend-core");
+const { getGlobalDB } = require("@budibase/backend-core/tenancy");
+const { updateAppPackage } = require("./application");
 exports.fetch = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
     const db = getAppDB();
     const screens = (yield db.allDocs(getScreenParams(null, {
@@ -28,11 +30,45 @@ exports.save = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
         eventFn = 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 = getGlobalDB();
+        const pluginsResponse = yield globalDB.allDocs(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(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 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();
@@ -45,3 +81,17 @@ exports.destroy = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
     };
     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/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)(), 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/api/routes/plugin.js

@@ -0,0 +1,39 @@
+"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/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/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({
@@ -195,7 +196,7 @@ exports.applicationValidator = () => {
     return joiValidator.body(Joi.object({
         _id: OPTIONAL_STRING,
         _rev: OPTIONAL_STRING,
-        name: Joi.string().required(),
+        name: Joi.string().pattern(new RegExp(APP_NAME_REGEX)).required().error(new Error('App name must be letters, numbers and spaces only')),
         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
@@ -150,6 +154,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

@@ -7,7 +7,7 @@ const AppStatus = {
     ALL: "all",
     DEPLOYED: "published",
 };
-const DocumentType = Object.assign(Object.assign({}, CoreDocTypes), { TABLE: "ta", ROW: "ro", USER: "us", AUTOMATION: "au", LINK: "li", WEBHOOK: "wh", INSTANCE: "inst", LAYOUT: "layout", SCREEN: "screen", DATASOURCE: "datasource", DATASOURCE_PLUS: "datasource_plus", QUERY: "query", DEPLOYMENTS: "deployments", METADATA: "metadata", MEM_VIEW: "view", USER_FLAG: "flag", AUTOMATION_METADATA: "meta_au" });
+const DocumentType = Object.assign(Object.assign({}, CoreDocTypes), { TABLE: "ta", ROW: "ro", USER: "us", AUTOMATION: "au", LINK: "li", WEBHOOK: "wh", INSTANCE: "inst", LAYOUT: "layout", SCREEN: "screen", DATASOURCE: "datasource", DATASOURCE_PLUS: "datasource_plus", QUERY: "query", DEPLOYMENTS: "deployments", METADATA: "metadata", MEM_VIEW: "view", USER_FLAG: "flag", AUTOMATION_METADATA: "meta_au", PLUGIN: "plg" });
 const InternalTables = {
     USER_METADATA: "ta_users",
 };
@@ -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
  */
@@ -283,3 +286,9 @@ exports.getMultiIDParams = ids => {
         include_docs: true,
     };
 };
+/**
+ * Gets parameters for retrieving automations, this is a utility function for the getDocParams function.
+ */
+exports.getPluginParams = (pluginId = null, otherProps = {}) => {
+    return getDocParams(DocumentType.PLUGIN, pluginId, otherProps);
+};

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,

package/dist/integrations/airtable.js

@@ -10,141 +10,138 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const types_1 = require("@budibase/types");
-var AirtableModule;
-(function (AirtableModule) {
-    const Airtable = require("airtable");
-    const SCHEMA = {
-        docs: "https://airtable.com/api",
-        description: "Airtable is a spreadsheet-database hybrid, with the features of a database but applied to a spreadsheet.",
-        friendlyName: "Airtable",
-        type: "Spreadsheet",
-        datasource: {
-            apiKey: {
-                type: types_1.DatasourceFieldType.PASSWORD,
-                default: "enter api key",
-                required: true,
-            },
-            base: {
-                type: types_1.DatasourceFieldType.STRING,
-                default: "mybase",
-                required: true,
-            },
+const Airtable = require("airtable");
+const SCHEMA = {
+    docs: "https://airtable.com/api",
+    description: "Airtable is a spreadsheet-database hybrid, with the features of a database but applied to a spreadsheet.",
+    friendlyName: "Airtable",
+    type: "Spreadsheet",
+    datasource: {
+        apiKey: {
+            type: types_1.DatasourceFieldType.PASSWORD,
+            default: "enter api key",
+            required: true,
         },
-        query: {
-            create: {
-                type: types_1.QueryType.FIELDS,
-                customisable: true,
-                fields: {
-                    table: {
-                        type: types_1.DatasourceFieldType.STRING,
-                        required: true,
-                    },
+        base: {
+            type: types_1.DatasourceFieldType.STRING,
+            default: "mybase",
+            required: true,
+        },
+    },
+    query: {
+        create: {
+            type: types_1.QueryType.FIELDS,
+            customisable: true,
+            fields: {
+                table: {
+                    type: types_1.DatasourceFieldType.STRING,
+                    required: true,
                 },
             },
-            read: {
-                type: types_1.QueryType.FIELDS,
-                fields: {
-                    table: {
-                        type: types_1.DatasourceFieldType.STRING,
-                        required: true,
-                    },
-                    view: {
-                        type: types_1.DatasourceFieldType.STRING,
-                        required: true,
-                    },
-                    numRecords: {
-                        type: types_1.DatasourceFieldType.NUMBER,
-                        default: 10,
-                    },
+        },
+        read: {
+            type: types_1.QueryType.FIELDS,
+            fields: {
+                table: {
+                    type: types_1.DatasourceFieldType.STRING,
+                    required: true,
                 },
-            },
-            update: {
-                type: types_1.QueryType.FIELDS,
-                customisable: true,
-                fields: {
-                    id: {
-                        display: "Record ID",
-                        type: types_1.DatasourceFieldType.STRING,
-                        required: true,
-                    },
-                    table: {
-                        type: types_1.DatasourceFieldType.STRING,
-                        required: true,
-                    },
+                view: {
+                    type: types_1.DatasourceFieldType.STRING,
+                    required: true,
+                },
+                numRecords: {
+                    type: types_1.DatasourceFieldType.NUMBER,
+                    default: 10,
                 },
             },
-            delete: {
-                type: types_1.QueryType.JSON,
+        },
+        update: {
+            type: types_1.QueryType.FIELDS,
+            customisable: true,
+            fields: {
+                id: {
+                    display: "Record ID",
+                    type: types_1.DatasourceFieldType.STRING,
+                    required: true,
+                },
+                table: {
+                    type: types_1.DatasourceFieldType.STRING,
+                    required: true,
+                },
             },
         },
-    };
-    class AirtableIntegration {
-        constructor(config) {
-            this.config = config;
-            this.client = new Airtable(config).base(config.base);
-        }
-        create(query) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const { table, json } = query;
-                try {
-                    return yield this.client(table).create([
-                        {
-                            fields: json,
-                        },
-                    ]);
-                }
-                catch (err) {
-                    console.error("Error writing to airtable", err);
-                    throw err;
-                }
-            });
-        }
-        read(query) {
-            return __awaiter(this, void 0, void 0, function* () {
-                try {
-                    const records = yield this.client(query.table)
-                        .select({ maxRecords: query.numRecords || 10, view: query.view })
-                        .firstPage();
-                    // @ts-ignore
-                    return records.map(({ fields }) => fields);
-                }
-                catch (err) {
-                    console.error("Error writing to airtable", err);
-                    return [];
-                }
-            });
-        }
-        update(query) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const { table, id, json } = query;
-                try {
-                    return yield this.client(table).update([
-                        {
-                            id,
-                            fields: json,
-                        },
-                    ]);
-                }
-                catch (err) {
-                    console.error("Error writing to airtable", err);
-                    throw err;
-                }
-            });
-        }
-        delete(query) {
-            return __awaiter(this, void 0, void 0, function* () {
-                try {
-                    return yield this.client(query.table).destroy(query.ids);
-                }
-                catch (err) {
-                    console.error("Error writing to airtable", err);
-                    throw err;
-                }
-            });
-        }
+        delete: {
+            type: types_1.QueryType.JSON,
+        },
+    },
+};
+class AirtableIntegration {
+    constructor(config) {
+        this.config = config;
+        this.client = new Airtable(config).base(config.base);
+    }
+    create(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { table, json } = query;
+            try {
+                return yield this.client(table).create([
+                    {
+                        fields: json,
+                    },
+                ]);
+            }
+            catch (err) {
+                console.error("Error writing to airtable", err);
+                throw err;
+            }
+        });
+    }
+    read(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const records = yield this.client(query.table)
+                    .select({ maxRecords: query.numRecords || 10, view: query.view })
+                    .firstPage();
+                // @ts-ignore
+                return records.map(({ fields }) => fields);
+            }
+            catch (err) {
+                console.error("Error writing to airtable", err);
+                return [];
+            }
+        });
+    }
+    update(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { table, id, json } = query;
+            try {
+                return yield this.client(table).update([
+                    {
+                        id,
+                        fields: json,
+                    },
+                ]);
+            }
+            catch (err) {
+                console.error("Error writing to airtable", err);
+                throw err;
+            }
+        });
+    }
+    delete(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield this.client(query.table).destroy(query.ids);
+            }
+            catch (err) {
+                console.error("Error writing to airtable", err);
+                throw err;
+            }
+        });
     }
-    module.exports = {
-        schema: SCHEMA,
-        integration: AirtableIntegration,
-    };
-})(AirtableModule || (AirtableModule = {}));
+}
+exports.default = {
+    schema: SCHEMA,
+    integration: AirtableIntegration,
+};