@budibase/server 2.2.25 → 2.2.27-alpha.0

package/dist/utilities/fileSystem/plugin.js

@@ -0,0 +1,66 @@
+"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.getDatasourcePlugin = exports.getPluginMetadata = void 0;
+const budibaseDir_1 = require("../budibaseDir");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = require("path");
+const backend_core_1 = require("@budibase/backend-core");
+const DATASOURCE_PATH = (0, path_1.join)((0, budibaseDir_1.budibaseTempDir)(), "datasource");
+const getPluginMetadata = (path) => __awaiter(void 0, void 0, void 0, function* () {
+    let metadata = {};
+    try {
+        const pkg = fs_1.default.readFileSync((0, path_1.join)(path, "package.json"), "utf8");
+        const schema = fs_1.default.readFileSync((0, path_1.join)(path, "schema.json"), "utf8");
+        metadata.schema = JSON.parse(schema);
+        metadata.package = JSON.parse(pkg);
+        if (!metadata.package.name ||
+            !metadata.package.version ||
+            !metadata.package.description) {
+            throw new Error("package.json is missing one of 'name', 'version' or 'description'.");
+        }
+    }
+    catch (err) {
+        throw new Error(`Unable to process schema.json/package.json in plugin. ${err.message}`);
+    }
+    return { metadata, directory: path };
+});
+exports.getPluginMetadata = getPluginMetadata;
+const getDatasourcePlugin = (plugin) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    const hash = (_a = plugin.schema) === null || _a === void 0 ? void 0 : _a.hash;
+    if (!fs_1.default.existsSync(DATASOURCE_PATH)) {
+        fs_1.default.mkdirSync(DATASOURCE_PATH);
+    }
+    const filename = (0, path_1.join)(DATASOURCE_PATH, plugin.name);
+    const metadataName = `${filename}.bbmetadata`;
+    if (fs_1.default.existsSync(filename)) {
+        const currentHash = fs_1.default.readFileSync(metadataName, "utf8");
+        // if hash is the same return the file, otherwise remove it and re-download
+        if (currentHash === hash) {
+            return require(filename);
+        }
+        else {
+            console.log(`Updating plugin: ${plugin.name}`);
+            delete require.cache[require.resolve(filename)];
+            fs_1.default.unlinkSync(filename);
+        }
+    }
+    const pluginKey = backend_core_1.objectStore.getPluginJSKey(plugin);
+    const pluginJs = yield backend_core_1.objectStore.retrieve(backend_core_1.objectStore.ObjectStoreBuckets.PLUGINS, pluginKey);
+    fs_1.default.writeFileSync(filename, pluginJs);
+    fs_1.default.writeFileSync(metadataName, hash);
+    return require(filename);
+});
+exports.getDatasourcePlugin = getDatasourcePlugin;

package/dist/utilities/fileSystem/template.js

@@ -0,0 +1,47 @@
+"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.downloadTemplate = exports.getTemplateStream = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = require("path");
+const constants_1 = require("../../constants");
+const backend_core_1 = require("@budibase/backend-core");
+/**
+ * This function manages temporary template files which are stored by Koa.
+ * @param {Object} template The template object retrieved from the Koa context object.
+ * @returns {Object} Returns an fs read stream which can be loaded into the database.
+ */
+const getTemplateStream = (template) => __awaiter(void 0, void 0, void 0, function* () {
+    if (template.file) {
+        return fs_1.default.createReadStream(template.file.path);
+    }
+    else {
+        const [type, name] = template.key.split("/");
+        const tmpPath = yield (0, exports.downloadTemplate)(type, name);
+        return fs_1.default.createReadStream((0, path_1.join)(tmpPath, name, "db", "dump.txt"));
+    }
+});
+exports.getTemplateStream = getTemplateStream;
+/**
+ * Retrieves a template and pipes it to minio as well as making it available temporarily.
+ * @param {string} type The type of template which is to be retrieved.
+ * @param name
+ * @return {Promise<*>}
+ */
+const downloadTemplate = (type, name) => __awaiter(void 0, void 0, void 0, function* () {
+    const DEFAULT_TEMPLATES_BUCKET = "prod-budi-templates.s3-eu-west-1.amazonaws.com";
+    const templateUrl = `https://${DEFAULT_TEMPLATES_BUCKET}/templates/${type}/${name}.tar.gz`;
+    return backend_core_1.objectStore.downloadTarball(templateUrl, constants_1.ObjectStoreBuckets.TEMPLATES, type);
+});
+exports.downloadTemplate = downloadTemplate;

package/dist/utilities/index.js

@@ -12,9 +12,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isQsTrue = exports.convertBookmark = exports.formatBytes = exports.stringToReadStream = exports.escapeDangerousCharacters = exports.deleteEntityMetadata = exports.saveEntityMetadata = exports.updateEntityMetadata = exports.attachmentsRelativeURL = exports.clientLibraryPath = exports.objectStoreUrl = exports.checkSlashesInUrl = exports.removeFromArray = exports.NUMBER_REGEX = exports.isDev = exports.wait = void 0;
+exports.isQsTrue = exports.convertBookmark = exports.formatBytes = exports.stringToReadStream = exports.escapeDangerousCharacters = exports.deleteEntityMetadata = exports.saveEntityMetadata = exports.updateEntityMetadata = exports.checkSlashesInUrl = exports.removeFromArray = exports.NUMBER_REGEX = exports.isDev = exports.wait = void 0;
 const environment_1 = __importDefault(require("../environment"));
-const constants_1 = require("../constants");
 const backend_core_1 = require("@budibase/backend-core");
 const utils_1 = require("../db/utils");
 const stream_1 = __importDefault(require("stream"));
@@ -43,48 +42,6 @@ function checkSlashesInUrl(url) {
     return url.replace(/(https?:\/\/)|(\/)+/g, "$1$2");
 }
 exports.checkSlashesInUrl = checkSlashesInUrl;
-/**
- * Gets the address of the object store, depending on whether self hosted or in cloud.
- * @return {string} The base URL of the object store (MinIO or S3).
- */
-function objectStoreUrl() {
-    if (environment_1.default.SELF_HOSTED || environment_1.default.MINIO_URL) {
-        // can use a relative url for this as all goes through the proxy (this is hosted in minio)
-        return constants_1.OBJ_STORE_DIRECTORY;
-    }
-    else {
-        return environment_1.default.CDN_URL;
-    }
-}
-exports.objectStoreUrl = objectStoreUrl;
-/**
- * In production the client library is stored in the object store, however in development
- * we use the symlinked version produced by lerna, located in node modules. We link to this
- * via a specific endpoint (under /api/assets/client).
- * @param {string} appId In production we need the appId to look up the correct bucket, as the
- * version of the client lib may differ between apps.
- * @param {string} version The version to retrieve.
- * @return {string} The URL to be inserted into appPackage response or server rendered
- * app index file.
- */
-function clientLibraryPath(appId, version) {
-    if (environment_1.default.isProd()) {
-        let url = `${objectStoreUrl()}/${backend_core_1.objectStore.sanitizeKey(appId)}/budibase-client.js`;
-        // append app version to bust the cache
-        if (version) {
-            url += `?v=${version}`;
-        }
-        return url;
-    }
-    else {
-        return `/api/assets/client`;
-    }
-}
-exports.clientLibraryPath = clientLibraryPath;
-function attachmentsRelativeURL(attachmentKey) {
-    return checkSlashesInUrl(`${objectStoreUrl()}/${attachmentKey}`);
-}
-exports.attachmentsRelativeURL = attachmentsRelativeURL;
 function updateEntityMetadata(type, entityId, updateFn) {
     return __awaiter(this, void 0, void 0, function* () {
         const db = backend_core_1.context.getAppDB();

package/dist/utilities/rowProcessor/index.js

@@ -38,7 +38,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cleanupAttachments = exports.outputProcessing = exports.inputProcessing = exports.coerce = exports.processAutoColumn = void 0;
 const linkRows = __importStar(require("../../db/linkedRows"));
 const constants_1 = require("../../constants");
-const index_1 = require("../index");
 const utils_1 = require("./utils");
 const constants_2 = require("../../constants");
 const backend_core_1 = require("@budibase/backend-core");
@@ -172,6 +171,15 @@ function inputProcessing(user, table, row, opts) {
         else {
             clonedRow[key] = coerce(value, field.type);
         }
+        // remove any attachment urls, they are generated on read
+        if (field.type === constants_1.FieldTypes.ATTACHMENT) {
+            const attachments = clonedRow[key];
+            if (attachments === null || attachments === void 0 ? void 0 : attachments.length) {
+                attachments.forEach((attachment) => {
+                    delete attachment.url;
+                });
+            }
+        }
     }
     if (!clonedRow._id || !clonedRow._rev) {
         clonedRow._id = row._id;
@@ -201,7 +209,7 @@ function outputProcessing(table, rows, opts = { squash: true }) {
         let enriched = yield linkRows.attachFullLinkedDocs(table, rows);
         // process formulas
         enriched = (0, utils_1.processFormulas)(table, enriched, { dynamic: true });
-        // update the attachments URL depending on hosting
+        // set the attachments URLs
         for (let [property, column] of Object.entries(table.schema)) {
             if (column.type === constants_1.FieldTypes.ATTACHMENT) {
                 for (let row of enriched) {
@@ -209,7 +217,7 @@ function outputProcessing(table, rows, opts = { squash: true }) {
                         continue;
                     }
                     row[property].forEach((attachment) => {
-                        attachment.url = (0, index_1.attachmentsRelativeURL)(attachment.key);
+                        attachment.url = backend_core_1.objectStore.getAppFileUrl(attachment.key);
                     });
                 }
             }
@@ -269,7 +277,7 @@ function cleanupAttachments(table, { row, rows, oldRow, oldTable, }) {
             }
         }
         if (files.length > 0) {
-            return backend_core_1.objectStore.deleteFiles(constants_2.ObjectStoreBuckets.APPS, files);
+            yield backend_core_1.objectStore.deleteFiles(constants_2.ObjectStoreBuckets.APPS, files);
         }
     });
 }

package/dist/utilities/schema.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parse = exports.validate = exports.isRows = exports.isSchema = void 0;
+const constants_1 = require("../constants");
+const PARSERS = {
+    [constants_1.FieldTypes.NUMBER]: (attribute) => {
+        if (!attribute) {
+            return attribute;
+        }
+        return Number(attribute);
+    },
+    [constants_1.FieldTypes.DATETIME]: (attribute) => {
+        if (!attribute) {
+            return attribute;
+        }
+        return new Date(attribute).toISOString();
+    },
+};
+function isSchema(schema) {
+    return (typeof schema === "object" &&
+        Object.values(schema).every(rawColumn => {
+            const column = rawColumn;
+            return (column !== null &&
+                typeof column === "object" &&
+                typeof column.type === "string" &&
+                Object.values(constants_1.FieldTypes).includes(column.type));
+        }));
+}
+exports.isSchema = isSchema;
+function isRows(rows) {
+    return Array.isArray(rows) && rows.every(row => typeof row === "object");
+}
+exports.isRows = isRows;
+function validate(rows, schema) {
+    const results = {
+        schemaValidation: {},
+        allValid: false,
+        invalidColumns: [],
+    };
+    rows.forEach(row => {
+        Object.entries(row).forEach(([columnName, columnData]) => {
+            var _a, _b;
+            const columnType = (_a = schema[columnName]) === null || _a === void 0 ? void 0 : _a.type;
+            const isAutoColumn = (_b = schema[columnName]) === null || _b === void 0 ? void 0 : _b.autocolumn;
+            // If the columnType is not a string, then it's not present in the schema, and should be added to the invalid columns array
+            if (typeof columnType !== "string") {
+                results.invalidColumns.push(columnName);
+            }
+            else if (
+            // If there's no data for this field don't bother with further checks
+            // If the field is already marked as invalid there's no need for further checks
+            results.schemaValidation[columnName] === false ||
+                columnData == null ||
+                isAutoColumn) {
+                return;
+            }
+            else if (columnType === constants_1.FieldTypes.NUMBER &&
+                isNaN(Number(columnData))) {
+                // If provided must be a valid number
+                results.schemaValidation[columnName] = false;
+            }
+            else if (
+            // If provided must be a valid date
+            columnType === constants_1.FieldTypes.DATETIME &&
+                isNaN(new Date(columnData).getTime())) {
+                results.schemaValidation[columnName] = false;
+            }
+            else {
+                results.schemaValidation[columnName] = true;
+            }
+        });
+    });
+    results.allValid =
+        Object.values(results.schemaValidation).length > 0 &&
+            Object.values(results.schemaValidation).every(column => column);
+    // Select unique values
+    results.invalidColumns = [...new Set(results.invalidColumns)];
+    return results;
+}
+exports.validate = validate;
+function parse(rows, schema) {
+    return rows.map(row => {
+        const parsedRow = {};
+        Object.entries(row).forEach(([columnName, columnData]) => {
+            var _a;
+            if (!(columnName in schema) || ((_a = schema[columnName]) === null || _a === void 0 ? void 0 : _a.autocolumn)) {
+                // Objects can be present in the row data but not in the schema, so make sure we don't proceed in such a case
+                return;
+            }
+            const columnType = schema[columnName].type;
+            if (columnType === constants_1.FieldTypes.NUMBER) {
+                // If provided must be a valid number
+                parsedRow[columnName] = columnData ? Number(columnData) : columnData;
+            }
+            else if (columnType === constants_1.FieldTypes.DATETIME) {
+                // If provided must be a valid date
+                parsedRow[columnName] = columnData
+                    ? new Date(columnData).toISOString()
+                    : columnData;
+            }
+            else {
+                parsedRow[columnName] = columnData;
+            }
+        });
+        return parsedRow;
+    });
+}
+exports.parse = parse;

package/dist/utilities/scriptRunner.js

@@ -2,6 +2,7 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+Object.defineProperty(exports, "__esModule", { value: true });
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const vm2_1 = require("vm2");
 const JS_TIMEOUT_MS = 1000;
@@ -22,4 +23,4 @@ class ScriptRunner {
         return this.results.out;
     }
 }
-module.exports = ScriptRunner;
+exports.default = ScriptRunner;

package/dist/utilities/statusCodes.js

@@ -1,5 +1,6 @@
 "use strict";
-module.exports = {
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
     OK: 200,
     UNAUTHORIZED: 401,
     FORBIDDEN: 403,

package/dist/utilities/workerRequests.js

@@ -41,6 +41,8 @@ function request(ctx, request) {
     if (ctx && ctx.headers) {
         request.headers = ctx.headers;
     }
+    // add x-budibase-correlation-id header
+    backend_core_1.logging.correlation.setHeader(request.headers);
     return request;
 }
 exports.request = request;

package/dist/watch.js

@@ -1,27 +1,4 @@
 "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 __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) {
@@ -37,13 +14,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.watch = void 0;
 const path_1 = __importDefault(require("path"));
-const env = __importStar(require("./environment"));
+const environment_1 = __importDefault(require("./environment"));
 const chokidar_1 = __importDefault(require("chokidar"));
 const fs_1 = __importDefault(require("fs"));
 const backend_core_1 = require("@budibase/backend-core");
 const plugin_1 = require("./api/controllers/plugin");
 function watch() {
-    const watchPath = path_1.default.join(env.PLUGINS_DIR, "./**/*.tar.gz");
+    const watchPath = path_1.default.join(environment_1.default.PLUGINS_DIR, "./**/*.tar.gz");
     chokidar_1.default
         .watch(watchPath, {
         ignored: "**/node_modules",

package/jest.config.ts

@@ -2,15 +2,18 @@ import { Config } from "@jest/types"
 import * as fs from "fs"
 
 const config: Config.InitialOptions = {
-  preset: "ts-jest",
   testEnvironment: "node",
-  setupFiles: ["./src/tests/jestSetup.ts"],
+  setupFiles: ["./src/tests/jestEnv.ts"],
+  setupFilesAfterEnv: ["./src/tests/jestSetup.ts"],
   collectCoverageFrom: [
     "src/**/*.{js,ts}",
     // The use of coverage with couchdb view functions breaks tests
     "!src/db/views/staticViews.*",
   ],
   coverageReporters: ["lcov", "json", "clover"],
+  transform: {
+    "^.+\\.ts?$": "@swc/jest",
+  },
 }
 
 if (!process.env.CI) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "2.2.25",
+  "version": "2.2.27-alpha.0",
   "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.2.25",
-    "@budibase/client": "^2.2.25",
-    "@budibase/pro": "2.2.24",
-    "@budibase/string-templates": "^2.2.25",
-    "@budibase/types": "^2.2.25",
+    "@budibase/backend-core": "2.2.27-alpha.0",
+    "@budibase/client": "2.2.27-alpha.0",
+    "@budibase/pro": "2.2.26",
+    "@budibase/string-templates": "2.2.27-alpha.0",
+    "@budibase/types": "2.2.27-alpha.0",
     "@bull-board/api": "3.7.0",
     "@bull-board/koa": "3.9.4",
     "@elastic/elasticsearch": "7.10.0",
@@ -77,7 +77,7 @@
     "joi": "17.6.0",
     "js-yaml": "4.1.0",
     "jsonschema": "1.4.0",
-    "knex": "0.95.15",
+    "knex": "2.4.0",
     "koa": "2.13.4",
     "koa-body": "4.2.0",
     "koa-compress": "4.0.1",
@@ -123,6 +123,8 @@
     "@babel/preset-env": "7.16.11",
     "@budibase/standard-components": "^0.9.139",
     "@jest/test-sequencer": "24.9.0",
+    "@swc/core": "^1.3.25",
+    "@swc/jest": "^0.2.24",
     "@types/apidoc": "0.50.0",
     "@types/bson": "4.2.0",
     "@types/global-agent": "2.1.1",
@@ -130,13 +132,15 @@
     "@types/ioredis": "4.28.10",
     "@types/jest": "27.5.1",
     "@types/koa": "2.13.4",
-    "@types/koa__router": "8.0.11",
+    "@types/koa__router": "8.0.8",
     "@types/lodash": "4.14.180",
     "@types/node": "14.18.20",
     "@types/node-fetch": "2.6.1",
     "@types/oracledb": "5.2.2",
     "@types/pouchdb": "6.4.0",
     "@types/redis": "4.0.11",
+    "@types/server-destroy": "1.0.1",
+    "@types/tar": "6.1.3",
     "@typescript-eslint/parser": "5.45.0",
     "apidoc": "0.50.4",
     "babel-jest": "27.5.1",
@@ -165,5 +169,5 @@
   "optionalDependencies": {
     "oracledb": "5.3.0"
   },
-  "gitHead": "08950831458dfcd113543eac920a9038968ddb8f"
+  "gitHead": "58f20501ab6d74756b2b5301e11767d6abaa4b39"
 }

package/scripts/dev/manage.js

@@ -29,13 +29,14 @@ async function init() {
       ACCOUNT_PORTAL_URL: "http://localhost:10001",
       ACCOUNT_PORTAL_API_KEY: "budibase",
       JWT_SECRET: "testsecret",
+      ENCRYPTION_KEY: "testsecret",
       REDIS_PASSWORD: "budibase",
       MINIO_ACCESS_KEY: "budibase",
       MINIO_SECRET_KEY: "budibase",
       COUCH_DB_PASSWORD: "budibase",
       COUCH_DB_USER: "budibase",
       SELF_HOSTED: 1,
-      DISABLE_ACCOUNT_PORTAL: "",
+      DISABLE_ACCOUNT_PORTAL: 1,
       MULTI_TENANCY: "",
       DISABLE_THREADING: 1,
       SERVICE: "app-service",
@@ -43,7 +44,7 @@ async function init() {
       BB_ADMIN_USER_EMAIL: "",
       BB_ADMIN_USER_PASSWORD: "",
       PLUGINS_DIR: "",
-      TENANT_FEATURE_FLAGS: "*:LICENSING,*:USER_GROUPS",
+      TENANT_FEATURE_FLAGS: "*:LICENSING,*:USER_GROUPS,*:ONBOARDING_TOUR",
     }
     let envFile = ""
     Object.keys(envFileJson).forEach(key => {

package/specs/openapi.json

@@ -567,6 +567,40 @@
           "data"
         ]
       },
+      "deploymentOutput": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "object",
+            "properties": {
+              "_id": {
+                "description": "The ID of the app.",
+                "type": "string"
+              },
+              "status": {
+                "description": "Status of the deployment, whether it succeeded or failed",
+                "type": "string",
+                "enum": [
+                  "SUCCESS",
+                  "FAILURE"
+                ]
+              },
+              "appUrl": {
+                "description": "The URL of the published app",
+                "type": "string"
+              }
+            },
+            "required": [
+              "_id",
+              "status",
+              "appUrl"
+            ]
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
       "row": {
         "description": "The row to be created/updated, based on the table schema.",
         "type": "object",
@@ -1933,6 +1967,56 @@
         }
       }
     },
+    "/applications/{appId}/unpublish": {
+      "post": {
+        "operationId": "unpublish",
+        "summary": "Unpublish an application",
+        "tags": [
+          "applications"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/appIdUrl"
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "The app was published successfully."
+          }
+        }
+      }
+    },
+    "/applications/{appId}/publish": {
+      "post": {
+        "operationId": "publish",
+        "summary": "Unpublish an application",
+        "tags": [
+          "applications"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/appIdUrl"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Returns the deployment object.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/deploymentOutput"
+                },
+                "examples": {
+                  "deployment": {
+                    "$ref": "#/components/examples/deploymentOutput"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/applications/search": {
       "post": {
         "operationId": "search",