@budibase/server 2.1.40-alpha.5 → 2.1.40-alpha.6

package/dist/migrations/functions/tableSettings.js

@@ -0,0 +1,130 @@
+"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.run = void 0;
+const utils_1 = require("../../db/utils");
+const string_templates_1 = require("@budibase/string-templates");
+/**
+ * Date:
+ * November 2022
+ *
+ * Description:
+ * Update table settings to use actions instead of links. We do not remove the
+ * legacy values here as we cannot guarantee that their apps are up-t-date.
+ * It is safe to simply save both the new and old structure in the definition.
+ *
+ * Migration 1:
+ * Legacy "linkRows", "linkURL", "linkPeek" and "linkColumn" settings on tables
+ * and table blocks are migrated into a "Navigate To" action under the new
+ * "onClick" setting.
+ *
+ * Migration 2:
+ * Legacy "titleButtonURL" and "titleButtonPeek" settings on table blocks are
+ * migrated into a "Navigate To" action under the new "onClickTitleButton"
+ * setting.
+ */
+const run = (appDb) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    // Get all app screens
+    let screens;
+    try {
+        screens = (yield appDb.allDocs((0, utils_1.getScreenParams)(null, {
+            include_docs: true,
+        }))).rows.map((row) => row.doc);
+    }
+    catch (e) {
+        // sometimes the metadata document doesn't exist
+        // exit early instead of failing the migration
+        console.error("Error retrieving app metadata. Skipping", e);
+        return;
+    }
+    // Recursively update any relevant components and mutate the screen docs
+    for (let screen of screens) {
+        const changed = migrateTableSettings(screen.props);
+        // Save screen if we updated it
+        if (changed) {
+            yield appDb.put(screen);
+            console.log(`Screen ${(_a = screen.routing) === null || _a === void 0 ? void 0 : _a.route} contained table settings which were migrated`);
+        }
+    }
+});
+exports.run = run;
+// Recursively searches and mutates a screen doc to migrate table component
+// and table block settings
+const migrateTableSettings = (component) => {
+    var _a;
+    let changed = false;
+    if (!component) {
+        return changed;
+    }
+    // Migration 1: migrate table row click settings
+    if (component._component.endsWith("/table") ||
+        component._component.endsWith("/tableblock")) {
+        const { linkRows, linkURL, linkPeek, linkColumn, onClick } = component;
+        if (linkRows && !onClick) {
+            const column = linkColumn || "_id";
+            const action = convertLinkSettingToAction(linkURL, !!linkPeek, column);
+            if (action) {
+                changed = true;
+                component.onClick = action;
+                if (component._component.endsWith("/tableblock")) {
+                    component.clickBehaviour = "actions";
+                }
+            }
+        }
+    }
+    // Migration 2: migrate table block title button settings
+    if (component._component.endsWith("/tableblock")) {
+        const { showTitleButton, titleButtonURL, titleButtonPeek, onClickTitleButton, } = component;
+        if (showTitleButton && !onClickTitleButton) {
+            const action = convertLinkSettingToAction(titleButtonURL, !!titleButtonPeek);
+            if (action) {
+                changed = true;
+                component.onClickTitleButton = action;
+                component.titleButtonClickBehaviour = "actions";
+            }
+        }
+    }
+    // Recurse down the tree as needed
+    (_a = component._children) === null || _a === void 0 ? void 0 : _a.forEach((child) => {
+        const childChanged = migrateTableSettings(child);
+        changed = changed || childChanged;
+    });
+    return changed;
+};
+// Util ti convert the legacy settings into a navigation action structure
+const convertLinkSettingToAction = (linkURL, linkPeek, linkColumn) => {
+    // Sanity check we have a URL
+    if (!linkURL) {
+        return null;
+    }
+    // Default URL to the old URL setting
+    let url = linkURL;
+    // If we enriched the old URL with a column, update the url
+    if (linkColumn && linkURL.includes("/:")) {
+        // Convert old link URL setting, which is a screen URL, into a valid
+        // binding using the new clicked row binding
+        const split = linkURL.split("/:");
+        const col = linkColumn || "_id";
+        const binding = `{{ ${(0, string_templates_1.makePropSafe)("eventContext")}.${(0, string_templates_1.makePropSafe)("row")}.${(0, string_templates_1.makePropSafe)(col)} }}`;
+        url = `${split[0]}/${binding}`;
+    }
+    // Create action structure
+    return [
+        {
+            "##eventHandlerType": "Navigate To",
+            parameters: {
+                url,
+                peek: linkPeek,
+            },
+        },
+    ];
+};

package/dist/migrations/index.js

@@ -43,6 +43,7 @@ const environment_1 = __importDefault(require("../environment"));
 const userEmailViewCasing = __importStar(require("./functions/userEmailViewCasing"));
 const syncQuotas = __importStar(require("./functions/syncQuotas"));
 const appUrls = __importStar(require("./functions/appUrls"));
+const tableSettings = __importStar(require("./functions/tableSettings"));
 const backfill = __importStar(require("./functions/backfill"));
 /**
  * Populate the migration function and additional configuration from
@@ -77,6 +78,10 @@ const buildMigrations = () => {
                 serverMigrations.push(Object.assign(Object.assign({}, definition), { fn: backfill.installation.run, silent: !!environment_1.default.SELF_HOSTED, preventRetry: !!environment_1.default.SELF_HOSTED }));
                 break;
             }
+            case types_1.MigrationName.TABLE_SETTINGS_LINKS_TO_ACTIONS: {
+                serverMigrations.push(Object.assign(Object.assign({}, definition), { appOpts: { dev: true }, fn: tableSettings.run }));
+                break;
+            }
         }
     }
     return serverMigrations;

package/dist/package.json

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