@budibase/server 0.0.32 → 0.0.999-alpha.30

package/dist/api/controllers/user.js

@@ -0,0 +1,124 @@
+"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.getFlags = exports.setFlag = exports.findMetadata = exports.destroyMetadata = exports.updateMetadata = exports.updateSelfMetadata = exports.fetchMetadata = void 0;
+const utils_1 = require("../../db/utils");
+const utils_2 = require("../../db/utils");
+const global_1 = require("../../utilities/global");
+const users_1 = require("../../utilities/users");
+const backend_core_1 = require("@budibase/backend-core");
+const sdk_1 = __importDefault(require("../../sdk"));
+function fetchMetadata(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const global = yield (0, global_1.getGlobalUsers)();
+        const metadata = yield sdk_1.default.users.rawUserMetadata();
+        const users = [];
+        for (let user of global) {
+            // find the metadata that matches up to the global ID
+            const info = metadata.find(meta => meta._id.includes(user._id));
+            // remove these props, not for the correct DB
+            users.push(Object.assign(Object.assign(Object.assign({}, user), info), { tableId: utils_2.InternalTables.USER_METADATA, 
+                // make sure the ID is always a local ID, not a global one
+                _id: (0, utils_1.generateUserMetadataID)(user._id) }));
+        }
+        ctx.body = users;
+    });
+}
+exports.fetchMetadata = fetchMetadata;
+function updateSelfMetadata(ctx) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        // overwrite the ID with current users
+        ctx.request.body._id = (_a = ctx.user) === null || _a === void 0 ? void 0 : _a._id;
+        // make sure no stale rev
+        delete ctx.request.body._rev;
+        // make sure no csrf token
+        delete ctx.request.body.csrfToken;
+        yield updateMetadata(ctx);
+    });
+}
+exports.updateSelfMetadata = updateSelfMetadata;
+function updateMetadata(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const user = ctx.request.body;
+        // this isn't applicable to the user
+        delete user.roles;
+        const metadata = Object.assign({ tableId: utils_2.InternalTables.USER_METADATA }, user);
+        ctx.body = yield db.put(metadata);
+    });
+}
+exports.updateMetadata = updateMetadata;
+function destroyMetadata(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        try {
+            const dbUser = yield db.get(ctx.params.id);
+            yield db.remove(dbUser._id, dbUser._rev);
+        }
+        catch (err) {
+            // error just means the global user has no config in this app
+        }
+        ctx.body = {
+            message: `User metadata ${ctx.params.id} deleted.`,
+        };
+    });
+}
+exports.destroyMetadata = destroyMetadata;
+function findMetadata(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        ctx.body = yield (0, users_1.getFullUser)(ctx, ctx.params.id);
+    });
+}
+exports.findMetadata = findMetadata;
+function setFlag(ctx) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const userId = (_a = ctx.user) === null || _a === void 0 ? void 0 : _a._id;
+        const { flag, value } = ctx.request.body;
+        if (!flag) {
+            ctx.throw(400, "Must supply a 'flag' field in request body.");
+        }
+        const flagDocId = (0, utils_1.generateUserFlagID)(userId);
+        const db = backend_core_1.context.getAppDB();
+        let doc;
+        try {
+            doc = yield db.get(flagDocId);
+        }
+        catch (err) {
+            doc = { _id: flagDocId };
+        }
+        doc[flag] = value || true;
+        yield db.put(doc);
+        ctx.body = { message: "Flag set successfully" };
+    });
+}
+exports.setFlag = setFlag;
+function getFlags(ctx) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const userId = (_a = ctx.user) === null || _a === void 0 ? void 0 : _a._id;
+        const docId = (0, utils_1.generateUserFlagID)(userId);
+        const db = backend_core_1.context.getAppDB();
+        let doc;
+        try {
+            doc = yield db.get(docId);
+        }
+        catch (err) {
+            doc = { _id: docId };
+        }
+        ctx.body = doc;
+    });
+}
+exports.getFlags = getFlags;

package/dist/api/controllers/view/exporters.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFormat = exports.Format = exports.jsonWithSchema = exports.json = exports.csv = void 0;
+function csv(headers, rows) {
+    let csv = headers.map(key => `"${key}"`).join(",");
+    for (let row of rows) {
+        csv = `${csv}\n${headers
+            .map(header => {
+            let val = row[header];
+            val =
+                typeof val === "object" && !(val instanceof Date)
+                    ? `"${JSON.stringify(val).replace(/"/g, "'")}"`
+                    : `"${val}"`;
+            return val.trim();
+        })
+            .join(",")}`;
+    }
+    return csv;
+}
+exports.csv = csv;
+function json(rows) {
+    return JSON.stringify(rows, undefined, 2);
+}
+exports.json = json;
+function jsonWithSchema(schema, rows) {
+    const newSchema = {};
+    Object.values(schema).forEach(column => {
+        if (!column.autocolumn) {
+            newSchema[column.name] = column;
+        }
+    });
+    return JSON.stringify({ schema: newSchema, rows }, undefined, 2);
+}
+exports.jsonWithSchema = jsonWithSchema;
+var Format;
+(function (Format) {
+    Format["CSV"] = "csv";
+    Format["JSON"] = "json";
+    Format["JSON_WITH_SCHEMA"] = "jsonWithSchema";
+})(Format = exports.Format || (exports.Format = {}));
+function isFormat(format) {
+    return Object.values(Format).includes(format);
+}
+exports.isFormat = isFormat;

package/dist/api/controllers/view/index.js

@@ -0,0 +1,193 @@
+"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 __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportView = exports.destroy = exports.filterEvents = exports.calculationEvents = exports.save = exports.fetch = void 0;
+const viewBuilder_1 = __importDefault(require("./viewBuilder"));
+const fileSystem_1 = require("../../../utilities/fileSystem");
+const exporters_1 = require("./exporters");
+const utils_1 = require("./utils");
+const row_1 = require("../row");
+const backend_core_1 = require("@budibase/backend-core");
+const utils_2 = require("../../../db/utils");
+const sdk_1 = __importDefault(require("../../../sdk"));
+const constants_1 = require("../../../constants");
+const utils_3 = require("../row/utils");
+const { cloneDeep, isEqual } = require("lodash");
+function fetch(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        ctx.body = yield (0, utils_1.getViews)();
+    });
+}
+exports.fetch = fetch;
+function save(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const _a = ctx.request.body, { originalName } = _a, viewToSave = __rest(_a, ["originalName"]);
+        const existingTable = yield db.get(ctx.request.body.tableId);
+        const table = cloneDeep(existingTable);
+        const groupByField = Object.values(table.schema).find((field) => field.name == viewToSave.groupBy);
+        const view = (0, viewBuilder_1.default)(viewToSave, (groupByField === null || groupByField === void 0 ? void 0 : groupByField.type) === constants_1.FieldTypes.ARRAY);
+        const viewName = viewToSave.name;
+        if (!viewName) {
+            ctx.throw(400, "Cannot create view without a name");
+        }
+        yield (0, utils_1.saveView)(originalName, viewName, view);
+        // add views to table document
+        if (!table.views)
+            table.views = {};
+        if (!view.meta.schema) {
+            view.meta.schema = table.schema;
+        }
+        table.views[viewName] = view.meta;
+        if (originalName) {
+            delete table.views[originalName];
+            existingTable.views[viewName] = existingTable.views[originalName];
+        }
+        yield db.put(table);
+        yield handleViewEvents(existingTable.views[viewName], table.views[viewName]);
+        ctx.body = Object.assign(Object.assign({}, table.views[viewToSave.name]), { name: viewToSave.name });
+    });
+}
+exports.save = save;
+function calculationEvents(existingView, newView) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const existingCalculation = existingView && existingView.calculation;
+        const newCalculation = newView && newView.calculation;
+        if (existingCalculation && !newCalculation) {
+            yield backend_core_1.events.view.calculationDeleted(existingView);
+        }
+        if (!existingCalculation && newCalculation) {
+            yield backend_core_1.events.view.calculationCreated(newView);
+        }
+        if (existingCalculation &&
+            newCalculation &&
+            existingCalculation !== newCalculation) {
+            yield backend_core_1.events.view.calculationUpdated(newView);
+        }
+    });
+}
+exports.calculationEvents = calculationEvents;
+function filterEvents(existingView, newView) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const hasExistingFilters = !!(existingView &&
+            existingView.filters &&
+            existingView.filters.length);
+        const hasNewFilters = !!(newView && newView.filters && newView.filters.length);
+        if (hasExistingFilters && !hasNewFilters) {
+            yield backend_core_1.events.view.filterDeleted(newView);
+        }
+        if (!hasExistingFilters && hasNewFilters) {
+            yield backend_core_1.events.view.filterCreated(newView);
+        }
+        if (hasExistingFilters &&
+            hasNewFilters &&
+            !isEqual(existingView.filters, newView.filters)) {
+            yield backend_core_1.events.view.filterUpdated(newView);
+        }
+    });
+}
+exports.filterEvents = filterEvents;
+function handleViewEvents(existingView, newView) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!existingView) {
+            yield backend_core_1.events.view.created(newView);
+        }
+        else {
+            yield backend_core_1.events.view.updated(newView);
+        }
+        yield calculationEvents(existingView, newView);
+        yield filterEvents(existingView, newView);
+    });
+}
+function destroy(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const viewName = decodeURIComponent(ctx.params.viewName);
+        const view = yield (0, utils_1.deleteView)(viewName);
+        const table = yield db.get(view.meta.tableId);
+        delete table.views[viewName];
+        yield db.put(table);
+        yield backend_core_1.events.view.deleted(view);
+        ctx.body = view;
+    });
+}
+exports.destroy = destroy;
+function exportView(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const viewName = decodeURIComponent(ctx.query.view);
+        const view = yield (0, utils_1.getView)(viewName);
+        const format = ctx.query.format;
+        if (!(0, exporters_1.isFormat)(format)) {
+            ctx.throw(400, "Format must be specified, either csv, json or jsonWithSchema");
+        }
+        if (view) {
+            ctx.params.viewName = viewName;
+            // Fetch view rows
+            ctx.query = {
+                group: view.meta.groupBy,
+                calculation: view.meta.calculation,
+                // @ts-ignore
+                stats: !!view.meta.field,
+                field: view.meta.field,
+            };
+        }
+        else {
+            // table all_ view
+            /* istanbul ignore next */
+            ctx.params.viewName = viewName;
+        }
+        yield (0, row_1.fetchView)(ctx);
+        let rows = ctx.body;
+        let schema = view && view.meta && view.meta.schema;
+        const tableId = ctx.params.tableId || view.meta.tableId;
+        const table = yield sdk_1.default.tables.getTable(tableId);
+        if (!schema) {
+            schema = table.schema;
+        }
+        let exportRows = (0, utils_3.cleanExportRows)(rows, schema, format, []);
+        if (format === exporters_1.Format.CSV) {
+            ctx.attachment(`${viewName}.csv`);
+            ctx.body = (0, fileSystem_1.apiFileReturn)((0, exporters_1.csv)(Object.keys(schema), exportRows));
+        }
+        else if (format === exporters_1.Format.JSON) {
+            ctx.attachment(`${viewName}.json`);
+            ctx.body = (0, fileSystem_1.apiFileReturn)((0, exporters_1.json)(exportRows));
+        }
+        else if (format === exporters_1.Format.JSON_WITH_SCHEMA) {
+            ctx.attachment(`${viewName}.json`);
+            ctx.body = (0, fileSystem_1.apiFileReturn)((0, exporters_1.jsonWithSchema)(schema, exportRows));
+        }
+        else {
+            throw "Format not recognised";
+        }
+        if (viewName.startsWith(utils_2.DocumentType.TABLE)) {
+            yield backend_core_1.events.table.exported(table, format);
+        }
+        else {
+            yield backend_core_1.events.view.exported(table, format);
+        }
+    });
+}
+exports.exportView = exportView;

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

@@ -0,0 +1,177 @@
+"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.getFromMemoryDoc = exports.getFromDesignDoc = exports.migrateToDesignView = exports.migrateToInMemoryView = exports.deleteView = exports.saveView = exports.getViews = exports.getView = void 0;
+const utils_1 = require("../../../db/utils");
+const environment_1 = __importDefault(require("../../../environment"));
+const backend_core_1 = require("@budibase/backend-core");
+const viewBuilder_1 = __importDefault(require("./viewBuilder"));
+function getView(viewName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        if (environment_1.default.SELF_HOSTED) {
+            const designDoc = yield db.get("_design/database");
+            return designDoc.views[viewName];
+        }
+        else {
+            // This is a table view, don't read the view from the DB
+            if (viewName.startsWith(utils_1.DocumentType.TABLE + utils_1.SEPARATOR)) {
+                return null;
+            }
+            try {
+                const viewDoc = yield db.get((0, utils_1.generateMemoryViewID)(viewName));
+                return viewDoc.view;
+            }
+            catch (err) {
+                // Return null when PouchDB doesn't found the view
+                if (err.status === 404) {
+                    return null;
+                }
+                throw err;
+            }
+        }
+    });
+}
+exports.getView = getView;
+function getViews() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        const response = [];
+        if (environment_1.default.SELF_HOSTED) {
+            const designDoc = yield db.get("_design/database");
+            for (let name of Object.keys(designDoc.views)) {
+                // Only return custom views, not built ins
+                const viewNames = Object.values(utils_1.ViewName);
+                if (viewNames.indexOf(name) !== -1) {
+                    continue;
+                }
+                response.push(Object.assign({ name }, designDoc.views[name]));
+            }
+        }
+        else {
+            const views = (yield db.allDocs((0, utils_1.getMemoryViewParams)({
+                include_docs: true,
+            }))).rows.map(row => row.doc);
+            for (let viewDoc of views) {
+                response.push(Object.assign({ name: viewDoc.name }, viewDoc.view));
+            }
+        }
+        return response;
+    });
+}
+exports.getViews = getViews;
+function saveView(originalName, viewName, viewTemplate) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        if (environment_1.default.SELF_HOSTED) {
+            const designDoc = yield db.get("_design/database");
+            designDoc.views = Object.assign(Object.assign({}, designDoc.views), { [viewName]: viewTemplate });
+            // view has been renamed
+            if (originalName) {
+                delete designDoc.views[originalName];
+            }
+            yield db.put(designDoc);
+        }
+        else {
+            const id = (0, utils_1.generateMemoryViewID)(viewName);
+            const originalId = originalName ? (0, utils_1.generateMemoryViewID)(originalName) : null;
+            const viewDoc = {
+                _id: id,
+                view: viewTemplate,
+                name: viewName,
+                tableId: viewTemplate.meta.tableId,
+            };
+            try {
+                const old = yield db.get(id);
+                if (originalId) {
+                    const originalDoc = yield db.get(originalId);
+                    yield db.remove(originalDoc._id, originalDoc._rev);
+                }
+                if (old && old._rev) {
+                    viewDoc._rev = old._rev;
+                }
+            }
+            catch (err) {
+                // didn't exist, just skip
+            }
+            yield db.put(viewDoc);
+        }
+    });
+}
+exports.saveView = saveView;
+function deleteView(viewName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const db = backend_core_1.context.getAppDB();
+        if (environment_1.default.SELF_HOSTED) {
+            const designDoc = yield db.get("_design/database");
+            const view = designDoc.views[viewName];
+            delete designDoc.views[viewName];
+            yield db.put(designDoc);
+            return view;
+        }
+        else {
+            const id = (0, utils_1.generateMemoryViewID)(viewName);
+            const viewDoc = yield db.get(id);
+            yield db.remove(viewDoc._id, viewDoc._rev);
+            return viewDoc.view;
+        }
+    });
+}
+exports.deleteView = deleteView;
+function migrateToInMemoryView(db, viewName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // delete the view initially
+        const designDoc = yield db.get("_design/database");
+        // run the view back through the view builder to update it
+        const view = (0, viewBuilder_1.default)(designDoc.views[viewName].meta);
+        delete designDoc.views[viewName];
+        yield db.put(designDoc);
+        yield exports.saveView(db, null, viewName, view);
+    });
+}
+exports.migrateToInMemoryView = migrateToInMemoryView;
+function migrateToDesignView(db, viewName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let view = yield db.get((0, utils_1.generateMemoryViewID)(viewName));
+        const designDoc = yield db.get("_design/database");
+        designDoc.views[viewName] = (0, viewBuilder_1.default)(view.view.meta);
+        yield db.put(designDoc);
+        yield db.remove(view._id, view._rev);
+    });
+}
+exports.migrateToDesignView = migrateToDesignView;
+function getFromDesignDoc(db, viewName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const designDoc = yield db.get("_design/database");
+        let view = designDoc.views[viewName];
+        if (view == null) {
+            throw { status: 404, message: "Unable to get view" };
+        }
+        return view;
+    });
+}
+exports.getFromDesignDoc = getFromDesignDoc;
+function getFromMemoryDoc(db, viewName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let view = yield db.get((0, utils_1.generateMemoryViewID)(viewName));
+        if (view) {
+            view = view.view;
+        }
+        else {
+            throw { status: 404, message: "Unable to get view" };
+        }
+        return view;
+    });
+}
+exports.getFromMemoryDoc = getFromMemoryDoc;