@budibase/server 1.3.15-alpha.0 → 1.3.15-alpha.1

package/dist/api/controllers/{plugin.js → plugin/index.js}

@@ -12,14 +12,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processPlugin = exports.destroy = exports.fetch = exports.upload = exports.getPlugins = void 0;
-const constants_1 = require("../../constants");
-const fileSystem_1 = require("../../utilities/fileSystem");
+exports.processPlugin = exports.storePlugin = exports.destroy = exports.fetch = exports.create = exports.upload = exports.getPlugins = void 0;
+const constants_1 = require("../../../constants");
+const fileSystem_1 = require("../../../utilities/fileSystem");
+const uploaders_1 = require("./uploaders");
 const tenancy_1 = require("@budibase/backend-core/tenancy");
-const utils_1 = require("../../db/utils");
+const plugins_1 = require("@budibase/backend-core/plugins");
+const utils_1 = require("../../../db/utils");
 const objectStore_1 = require("@budibase/backend-core/objectStore");
 const types_1 = require("@budibase/types");
-const environment_1 = __importDefault(require("../../environment"));
+const environment_1 = __importDefault(require("../../../environment"));
 function getPlugins(type) {
     return __awaiter(this, void 0, void 0, function* () {
         const db = (0, tenancy_1.getGlobalDB)();
@@ -45,7 +47,7 @@ function upload(ctx) {
             let docs = [];
             // can do single or multiple plugins
             for (let plugin of plugins) {
-                const doc = yield processPlugin(plugin);
+                const doc = yield processPlugin(plugin, types_1.PluginSource.FILE);
                 docs.push(doc);
             }
             ctx.body = {
@@ -60,6 +62,50 @@ function upload(ctx) {
     });
 }
 exports.upload = upload;
+function create(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { source, url, headers, githubToken } = ctx.request.body;
+        if (!environment_1.default.SELF_HOSTED) {
+            ctx.throw(400, "Plugins not supported outside of self-host.");
+        }
+        try {
+            let metadata;
+            let directory;
+            // Generating random name as a backup and needed for url
+            let name = "PLUGIN_" + Math.floor(100000 + Math.random() * 900000);
+            switch (source) {
+                case types_1.PluginSource.NPM:
+                    const { metadata: metadataNpm, directory: directoryNpm } = yield (0, uploaders_1.npmUpload)(url, name);
+                    metadata = metadataNpm;
+                    directory = directoryNpm;
+                    break;
+                case types_1.PluginSource.GITHUB:
+                    const { metadata: metadataGithub, directory: directoryGithub } = yield (0, uploaders_1.githubUpload)(url, name, githubToken);
+                    metadata = metadataGithub;
+                    directory = directoryGithub;
+                    break;
+                case types_1.PluginSource.URL:
+                    const headersObj = headers || {};
+                    const { metadata: metadataUrl, directory: directoryUrl } = yield (0, uploaders_1.urlUpload)(url, name, headersObj);
+                    metadata = metadataUrl;
+                    directory = directoryUrl;
+                    break;
+            }
+            (0, plugins_1.validate)(metadata === null || metadata === void 0 ? void 0 : metadata.schema);
+            const doc = yield storePlugin(metadata, directory, source);
+            ctx.body = {
+                message: "Plugin uploaded successfully",
+                plugins: [doc],
+            };
+        }
+        catch (err) {
+            const errMsg = (err === null || err === void 0 ? void 0 : err.message) ? err === null || err === void 0 ? void 0 : err.message : err;
+            ctx.throw(400, `Failed to import plugin: ${errMsg}`);
+        }
+        ctx.status = 200;
+    });
+}
+exports.create = create;
 function fetch(ctx) {
     return __awaiter(this, void 0, void 0, function* () {
         ctx.body = yield getPlugins();
@@ -67,16 +113,27 @@ function fetch(ctx) {
 }
 exports.fetch = fetch;
 function destroy(ctx) {
-    return __awaiter(this, void 0, void 0, function* () { });
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = (0, tenancy_1.getGlobalDB)();
+        const { pluginId } = ctx.params;
+        try {
+            const plugin = yield db.get(pluginId);
+            const bucketPath = `${plugin.name}/`;
+            yield (0, objectStore_1.deleteFolder)(constants_1.ObjectStoreBuckets.PLUGINS, bucketPath);
+            yield db.remove(pluginId, plugin._rev);
+        }
+        catch (err) {
+            const errMsg = (err === null || err === void 0 ? void 0 : err.message) ? err === null || err === void 0 ? void 0 : err.message : err;
+            ctx.throw(400, `Failed to delete plugin: ${errMsg}`);
+        }
+        ctx.message = `Plugin ${ctx.params.pluginId} deleted.`;
+        ctx.status = 200;
+    });
 }
 exports.destroy = destroy;
-function processPlugin(plugin) {
+function storePlugin(metadata, directory, source) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!environment_1.default.SELF_HOSTED) {
-            throw new Error("Plugins not supported outside of self-host.");
-        }
         const db = (0, tenancy_1.getGlobalDB)();
-        const { metadata, directory } = yield (0, fileSystem_1.extractPluginTarball)(plugin);
         const version = metadata.package.version, name = metadata.package.name, description = metadata.package.description;
         // first open the tarball into tmp directory
         const bucketPath = `${name}/`;
@@ -109,11 +166,24 @@ function processPlugin(plugin) {
         catch (err) {
             rev = undefined;
         }
-        const doc = Object.assign(Object.assign({ _id: pluginId, _rev: rev }, metadata), { name,
+        let doc = Object.assign(Object.assign({ _id: pluginId, _rev: rev }, metadata), { name,
             version,
             description, jsUrl: `${bucketPath}${jsFileName}` });
+        if (source) {
+            doc = Object.assign(Object.assign({}, doc), { source });
+        }
         const response = yield db.put(doc);
         return Object.assign(Object.assign({}, doc), { _rev: response.rev });
     });
 }
+exports.storePlugin = storePlugin;
+function processPlugin(plugin, source) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!environment_1.default.SELF_HOSTED) {
+            throw new Error("Plugins not supported outside of self-host.");
+        }
+        const { metadata, directory } = yield (0, uploaders_1.fileUpload)(plugin);
+        return yield storePlugin(metadata, directory, source);
+    });
+}
 exports.processPlugin = processPlugin;

package/dist/api/controllers/plugin/npm.js

@@ -0,0 +1,58 @@
+"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 });
+exports.npmUpload = void 0;
+const fileSystem_1 = require("../../../utilities/fileSystem");
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const path_1 = require("path");
+const utils_1 = require("./utils");
+function npmUpload(url, name, headers = {}) {
+    var _a, _b, _c;
+    return __awaiter(this, void 0, void 0, function* () {
+        let npmTarballUrl = url;
+        let pluginName = name;
+        if (!npmTarballUrl.includes("https://www.npmjs.com") &&
+            !npmTarballUrl.includes("https://registry.npmjs.org")) {
+            throw new Error("The plugin origin must be from NPM");
+        }
+        if (!npmTarballUrl.includes(".tgz")) {
+            const npmPackageURl = url.replace("https://www.npmjs.com/package/", "https://registry.npmjs.org/");
+            const response = yield (0, node_fetch_1.default)(npmPackageURl);
+            if (response.status !== 200) {
+                throw new Error("NPM Package not found");
+            }
+            let npmDetails = yield response.json();
+            pluginName = npmDetails.name;
+            const npmVersion = npmDetails["dist-tags"].latest;
+            npmTarballUrl = (_c = (_b = (_a = npmDetails === null || npmDetails === void 0 ? void 0 : npmDetails.versions) === null || _a === void 0 ? void 0 : _a[npmVersion]) === null || _b === void 0 ? void 0 : _b.dist) === null || _c === void 0 ? void 0 : _c.tarball;
+            if (!npmTarballUrl) {
+                throw new Error("NPM tarball url not found");
+            }
+        }
+        const path = yield (0, utils_1.downloadUnzipTarball)(npmTarballUrl, pluginName, headers);
+        const tarballPluginFile = (0, fileSystem_1.findFileRec)(path, ".tar.gz");
+        if (!tarballPluginFile) {
+            throw new Error("Tarball plugin file not found");
+        }
+        try {
+            yield (0, fileSystem_1.extractTarball)(tarballPluginFile, path);
+            (0, fileSystem_1.deleteFolderFileSystem)((0, path_1.join)(path, "package"));
+        }
+        catch (err) {
+            throw new Error(err);
+        }
+        return yield (0, fileSystem_1.getPluginMetadata)(path);
+    });
+}
+exports.npmUpload = npmUpload;

package/dist/api/controllers/plugin/uploaders.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.urlUpload = exports.npmUpload = exports.githubUpload = exports.fileUpload = void 0;
+var file_1 = require("./file");
+Object.defineProperty(exports, "fileUpload", { enumerable: true, get: function () { return file_1.fileUpload; } });
+var github_1 = require("./github");
+Object.defineProperty(exports, "githubUpload", { enumerable: true, get: function () { return github_1.githubUpload; } });
+var npm_1 = require("./npm");
+Object.defineProperty(exports, "npmUpload", { enumerable: true, get: function () { return npm_1.npmUpload; } });
+var url_1 = require("./url");
+Object.defineProperty(exports, "urlUpload", { enumerable: true, get: function () { return url_1.urlUpload; } });

package/dist/api/controllers/plugin/url.js

@@ -0,0 +1,24 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.urlUpload = void 0;
+const utils_1 = require("./utils");
+const fileSystem_1 = require("../../../utilities/fileSystem");
+function urlUpload(url, name = "", headers = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!url.includes(".tar.gz")) {
+            throw new Error("Plugin must be compressed into a gzipped tarball.");
+        }
+        const path = yield (0, utils_1.downloadUnzipTarball)(url, name, headers);
+        return yield (0, fileSystem_1.getPluginMetadata)(path);
+    });
+}
+exports.urlUpload = urlUpload;

package/dist/api/controllers/plugin/utils.js

@@ -0,0 +1,26 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadUnzipTarball = void 0;
+const fileSystem_1 = require("../../../utilities/fileSystem");
+function downloadUnzipTarball(url, name, headers = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const path = (0, fileSystem_1.createTempFolder)(name);
+            yield (0, fileSystem_1.downloadTarballDirect)(url, path, headers);
+            return path;
+        }
+        catch (e) {
+            throw new Error(e.message);
+        }
+    });
+}
+exports.downloadUnzipTarball = downloadUnzipTarball;

package/dist/api/routes/plugin.js

@@ -33,6 +33,7 @@ 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/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@budibase/server",
     "email": "hi@budibase.com",
-    "version": "1.3.14",
+    "version": "1.3.15-alpha.0",
     "description": "Budibase Web Server",
     "main": "src/index.ts",
     "repository": {
@@ -77,11 +77,11 @@
     "license": "GPL-3.0",
     "dependencies": {
         "@apidevtools/swagger-parser": "10.0.3",
-        "@budibase/backend-core": "^1.3.14",
-        "@budibase/client": "^1.3.14",
-        "@budibase/pro": "1.3.13",
-        "@budibase/string-templates": "^1.3.14",
-        "@budibase/types": "^1.3.14",
+        "@budibase/backend-core": "1.3.15-alpha.0",
+        "@budibase/client": "1.3.15-alpha.0",
+        "@budibase/pro": "1.3.15-alpha.0",
+        "@budibase/string-templates": "1.3.15-alpha.0",
+        "@budibase/types": "1.3.15-alpha.0",
         "@bull-board/api": "3.7.0",
         "@bull-board/koa": "3.9.4",
         "@elastic/elasticsearch": "7.10.0",