@budibase/server 1.3.14 → 1.3.15-alpha.2

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/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/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,
+};

package/dist/integrations/arangodb.js

@@ -10,95 +10,92 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const types_1 = require("@budibase/types");
-var ArangoModule;
-(function (ArangoModule) {
-    const { Database, aql } = require("arangojs");
-    const SCHEMA = {
-        docs: "https://github.com/arangodb/arangojs",
-        friendlyName: "ArangoDB",
-        type: "Non-relational",
-        description: "ArangoDB is a scalable open-source multi-model database natively supporting graph, document and search. All supported data models & access patterns can be combined in queries allowing for maximal flexibility. ",
-        datasource: {
-            url: {
-                type: types_1.DatasourceFieldType.STRING,
-                default: "http://localhost:8529",
-                required: true,
-            },
-            username: {
-                type: types_1.DatasourceFieldType.STRING,
-                default: "root",
-                required: true,
-            },
-            password: {
-                type: types_1.DatasourceFieldType.PASSWORD,
-                required: true,
-            },
-            databaseName: {
-                type: types_1.DatasourceFieldType.STRING,
-                default: "_system",
-                required: true,
-            },
-            collection: {
-                type: types_1.DatasourceFieldType.STRING,
-                required: true,
-            },
+const { Database, aql } = require("arangojs");
+const SCHEMA = {
+    docs: "https://github.com/arangodb/arangojs",
+    friendlyName: "ArangoDB",
+    type: "Non-relational",
+    description: "ArangoDB is a scalable open-source multi-model database natively supporting graph, document and search. All supported data models & access patterns can be combined in queries allowing for maximal flexibility. ",
+    datasource: {
+        url: {
+            type: types_1.DatasourceFieldType.STRING,
+            default: "http://localhost:8529",
+            required: true,
         },
-        query: {
-            read: {
-                type: types_1.QueryType.SQL,
-            },
-            create: {
-                type: types_1.QueryType.JSON,
-            },
+        username: {
+            type: types_1.DatasourceFieldType.STRING,
+            default: "root",
+            required: true,
+        },
+        password: {
+            type: types_1.DatasourceFieldType.PASSWORD,
+            required: true,
+        },
+        databaseName: {
+            type: types_1.DatasourceFieldType.STRING,
+            default: "_system",
+            required: true,
         },
-    };
-    class ArangoDBIntegration {
-        constructor(config) {
-            const newConfig = {
-                auth: {
-                    username: config.username,
-                    password: config.password,
-                },
-            };
-            this.config = config;
-            this.client = new Database(newConfig);
-        }
-        read(query) {
-            return __awaiter(this, void 0, void 0, function* () {
-                try {
-                    const result = yield this.client.query(query.sql);
-                    return result.all();
-                }
-                catch (err) {
-                    // @ts-ignore
-                    console.error("Error querying arangodb", err.message);
-                    throw err;
-                }
-                finally {
-                    this.client.close();
-                }
-            });
-        }
-        create(query) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const clc = this.client.collection(this.config.collection);
-                try {
-                    const result = yield this.client.query(aql `INSERT ${query.json} INTO ${clc} RETURN NEW`);
-                    return result.all();
-                }
-                catch (err) {
-                    // @ts-ignore
-                    console.error("Error querying arangodb", err.message);
-                    throw err;
-                }
-                finally {
-                    this.client.close();
-                }
-            });
-        }
+        collection: {
+            type: types_1.DatasourceFieldType.STRING,
+            required: true,
+        },
+    },
+    query: {
+        read: {
+            type: types_1.QueryType.SQL,
+        },
+        create: {
+            type: types_1.QueryType.JSON,
+        },
+    },
+};
+class ArangoDBIntegration {
+    constructor(config) {
+        const newConfig = {
+            auth: {
+                username: config.username,
+                password: config.password,
+            },
+        };
+        this.config = config;
+        this.client = new Database(newConfig);
+    }
+    read(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield this.client.query(query.sql);
+                return result.all();
+            }
+            catch (err) {
+                // @ts-ignore
+                console.error("Error querying arangodb", err.message);
+                throw err;
+            }
+            finally {
+                this.client.close();
+            }
+        });
     }
-    module.exports = {
-        schema: SCHEMA,
-        integration: ArangoDBIntegration,
-    };
-})(ArangoModule || (ArangoModule = {}));
+    create(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const clc = this.client.collection(this.config.collection);
+            try {
+                const result = yield this.client.query(aql `INSERT ${query.json} INTO ${clc} RETURN NEW`);
+                return result.all();
+            }
+            catch (err) {
+                // @ts-ignore
+                console.error("Error querying arangodb", err.message);
+                throw err;
+            }
+            finally {
+                this.client.close();
+            }
+        });
+    }
+}
+exports.default = {
+    schema: SCHEMA,
+    integration: ArangoDBIntegration,
+};

package/dist/integrations/base/query.js

@@ -10,10 +10,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeExternalQuery = void 0;
-const { integrations } = require("../index");
+const { getIntegration } = require("../index");
 function makeExternalQuery(datasource, json) {
     return __awaiter(this, void 0, void 0, function* () {
-        const Integration = integrations[datasource.source];
+        const Integration = yield getIntegration(datasource.source);
         // query is the opinionated function
         if (Integration.prototype.query) {
             const integration = new Integration(datasource.config);