@budibase/server 1.0.26 → 1.0.27-alpha.0

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

@@ -9,10 +9,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 const { processString } = require("@budibase/string-templates");
-const CouchDB = require("../../db");
-const { generateQueryID, getQueryParams, isProdAppID, } = require("../../db/utils");
-const { BaseQueryVerbs } = require("../../constants");
-const { Thread, ThreadType } = require("../../threads");
+const CouchDB = require("../../../db");
+const { generateQueryID, getQueryParams, isProdAppID, } = require("../../../db/utils");
+const { BaseQueryVerbs } = require("../../../constants");
+const { Thread, ThreadType } = require("../../../threads");
+const { save: saveDatasource } = require("../datasource");
+const { RestImporter } = require("./import");
 const Runner = new Thread(ThreadType.QUERY, { timeoutMs: 10000 });
 // simple function to append "readable" to all read queries
 function enrichQueries(input) {
@@ -34,6 +36,38 @@ exports.fetch = function (ctx) {
         ctx.body = enrichQueries(body.rows.map(row => row.doc));
     });
 };
+exports.import = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+    const body = ctx.request.body;
+    const data = body.data;
+    const importer = new RestImporter(data);
+    yield importer.init();
+    let datasourceId;
+    if (!body.datasourceId) {
+        // construct new datasource
+        const info = yield importer.getInfo();
+        let datasource = {
+            type: "datasource",
+            source: "REST",
+            config: {
+                url: info.url,
+                defaultHeaders: [],
+            },
+            name: info.name,
+        };
+        // save the datasource
+        const datasourceCtx = Object.assign({}, ctx);
+        datasourceCtx.request.body.datasource = datasource;
+        yield saveDatasource(datasourceCtx);
+        datasourceId = datasourceCtx.body.datasource._id;
+    }
+    else {
+        // use existing datasource
+        datasourceId = body.datasourceId;
+    }
+    const importResult = yield importer.importQueries(ctx.appId, datasourceId);
+    ctx.body = Object.assign(Object.assign({}, importResult), { datasourceId });
+    ctx.status = 200;
+});
 exports.save = function (ctx) {
     return __awaiter(this, void 0, void 0, function* () {
         const db = new CouchDB(ctx.appId);
@@ -78,7 +112,7 @@ function enrichQueryFields(fields, parameters = {}) {
                     enrichedQuery.requestBody);
             }
             catch (err) {
-                throw { message: `JSON Invalid - error: ${err}` };
+                // no json found, ignore
             }
             delete enrichedQuery.customData;
         }
@@ -104,7 +138,7 @@ exports.preview = function (ctx) {
         const { fields, parameters, queryVerb, transformer } = ctx.request.body;
         const enrichedQuery = yield enrichQueryFields(fields, parameters);
         try {
-            const { rows, keys } = yield Runner.run({
+            const { rows, keys, info, extra } = yield Runner.run({
                 datasource,
                 queryVerb,
                 query: enrichedQuery,
@@ -113,6 +147,8 @@ exports.preview = function (ctx) {
             ctx.body = {
                 rows,
                 schemaFields: [...new Set(keys)],
+                info,
+                extra,
             };
         }
         catch (err) {

package/dist/api/controllers/query/validation.js

@@ -0,0 +1,37 @@
+"use strict";
+const joiValidator = require("../../../middleware/joi-validator");
+const Joi = require("joi");
+exports.queryValidation = () => {
+    return Joi.object({
+        _id: Joi.string(),
+        _rev: Joi.string(),
+        name: Joi.string().required(),
+        fields: Joi.object().required(),
+        datasourceId: Joi.string().required(),
+        readable: Joi.boolean(),
+        parameters: Joi.array().items(Joi.object({
+            name: Joi.string(),
+            default: Joi.string().allow(""),
+        })),
+        queryVerb: Joi.string().allow().required(),
+        extra: Joi.object().optional(),
+        schema: Joi.object({}).required().unknown(true),
+        transformer: Joi.string().optional(),
+        flags: Joi.object().optional(),
+    });
+};
+exports.generateQueryValidation = () => {
+    // prettier-ignore
+    return joiValidator.body(exports.queryValidation());
+};
+exports.generateQueryPreviewValidation = () => {
+    // prettier-ignore
+    return joiValidator.body(Joi.object({
+        fields: Joi.object().required(),
+        queryVerb: Joi.string().allow().required(),
+        extra: Joi.object().optional(),
+        datasourceId: Joi.string().required(),
+        transformer: Joi.string().optional(),
+        parameters: Joi.object({}).required().unknown(true)
+    }));
+};

package/dist/api/controllers/user.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 const CouchDB = require("../../db");
-const { generateUserMetadataID, getUserMetadataParams, } = require("../../db/utils");
+const { generateUserMetadataID, getUserMetadataParams, generateUserFlagID, } = require("../../db/utils");
 const { InternalTables } = require("../../db/utils");
 const { getGlobalUsers, getRawGlobalUser } = require("../../utilities/global");
 const { getFullUser } = require("../../utilities/users");
@@ -189,3 +189,39 @@ exports.findMetadata = function (ctx) {
         ctx.body = yield getFullUser(ctx, ctx.params.id);
     });
 };
+exports.setFlag = function (ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const userId = ctx.user._id;
+        const { flag, value } = ctx.request.body;
+        if (!flag) {
+            ctx.throw(400, "Must supply a 'flag' field in request body.");
+        }
+        const flagDocId = generateUserFlagID(userId);
+        const db = new CouchDB(ctx.appId);
+        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.getFlags = function (ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const userId = ctx.user._id;
+        const docId = generateUserFlagID(userId);
+        const db = new CouchDB(ctx.appId);
+        let doc;
+        try {
+            doc = yield db.get(docId);
+        }
+        catch (err) {
+            doc = { _id: docId };
+        }
+        ctx.body = doc;
+    });
+};

package/dist/api/controllers/webhook.js

@@ -65,6 +65,10 @@ exports.buildSchema = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
         let automation = yield db.get(webhook.action.target);
         const autoOutputs = automation.definition.trigger.schema.outputs;
         let properties = webhook.bodySchema.properties;
+        // reset webhook outputs
+        autoOutputs.properties = {
+            body: autoOutputs.properties.body,
+        };
         for (let prop of Object.keys(properties)) {
             autoOutputs.properties[prop] = {
                 type: properties[prop].type,

package/dist/api/routes/query.js

@@ -2,44 +2,14 @@
 const Router = require("@koa/router");
 const queryController = require("../controllers/query");
 const authorized = require("../../middleware/authorized");
-const Joi = require("joi");
 const { PermissionLevels, PermissionTypes, BUILDER, } = require("@budibase/auth/permissions");
-const joiValidator = require("../../middleware/joi-validator");
 const { bodyResource, bodySubResource, paramResource, } = require("../../middleware/resourceId");
+const { generateQueryPreviewValidation, generateQueryValidation, } = require("../controllers/query/validation");
 const router = Router();
-function generateQueryValidation() {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        _id: Joi.string(),
-        _rev: Joi.string(),
-        name: Joi.string().required(),
-        fields: Joi.object().required(),
-        datasourceId: Joi.string().required(),
-        readable: Joi.boolean(),
-        parameters: Joi.array().items(Joi.object({
-            name: Joi.string(),
-            default: Joi.string().allow(""),
-        })),
-        queryVerb: Joi.string().allow().required(),
-        extra: Joi.object().optional(),
-        schema: Joi.object({}).required().unknown(true),
-        transformer: Joi.string().optional(),
-    }));
-}
-function generateQueryPreviewValidation() {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        fields: Joi.object().required(),
-        queryVerb: Joi.string().allow().required(),
-        extra: Joi.object().optional(),
-        datasourceId: Joi.string().required(),
-        transformer: Joi.string().optional(),
-        parameters: Joi.object({}).required().unknown(true)
-    }));
-}
 router
     .get("/api/queries", authorized(BUILDER), queryController.fetch)
     .post("/api/queries", bodySubResource("datasourceId", "_id"), authorized(BUILDER), generateQueryValidation(), queryController.save)
+    .post("/api/queries/import", authorized(BUILDER), queryController.import)
     .post("/api/queries/preview", bodyResource("datasourceId"), authorized(BUILDER), generateQueryPreviewValidation(), queryController.preview)
     .get("/api/queries/:queryId", paramResource("queryId"), authorized(PermissionTypes.QUERY, PermissionLevels.READ), queryController.find)
     .post("/api/queries/:queryId", paramResource("queryId"), authorized(PermissionTypes.QUERY, PermissionLevels.WRITE), queryController.execute)

package/dist/api/routes/user.js

@@ -10,5 +10,7 @@ router
     .put("/api/users/metadata", authorized(PermissionTypes.USER, PermissionLevels.WRITE), controller.updateMetadata)
     .post("/api/users/metadata/self", authorized(PermissionTypes.USER, PermissionLevels.WRITE), controller.updateSelfMetadata)
     .delete("/api/users/metadata/:id", authorized(PermissionTypes.USER, PermissionLevels.WRITE), controller.destroyMetadata)
-    .post("/api/users/metadata/sync/:id", authorized(PermissionTypes.USER, PermissionLevels.WRITE), controller.syncUser);
+    .post("/api/users/metadata/sync/:id", authorized(PermissionTypes.USER, PermissionLevels.WRITE), controller.syncUser)
+    .post("/api/users/flags", authorized(PermissionTypes.USER, PermissionLevels.WRITE), controller.setFlag)
+    .get("/api/users/flags", authorized(PermissionTypes.USER, PermissionLevels.READ), controller.getFlags);
 module.exports = router;

package/dist/automations/steps/outgoingWebhook.js

@@ -20,11 +20,10 @@ const RequestType = {
 };
 const BODY_REQUESTS = [RequestType.POST, RequestType.PUT, RequestType.PATCH];
 /**
- * Note, there is some functionality in this that is not currently exposed as it
- * is complex and maybe better to be opinionated here.
- * GET/DELETE requests cannot handle body elements so they will not be sent if configured.
+ * NOTE: this functionality is deprecated - it no longer should be used.
  */
 exports.definition = {
+    deprecated: true,
     name: "Outgoing webhook",
     tagline: "Send a {{inputs.requestMethod}} request",
     icon: "Send",

package/dist/automations/utils.js

@@ -17,6 +17,7 @@ const newid = require("../db/newid");
 const { updateEntityMetadata } = require("../utilities");
 const { MetadataTypes } = require("../constants");
 const { getDeployedAppID } = require("@budibase/auth/db");
+const { cloneDeep } = require("lodash/fp");
 const WH_STEP_ID = definitions.WEBHOOK.stepId;
 const CRON_STEP_ID = definitions.CRON.stepId;
 const Runner = new Thread(ThreadType.AUTOMATION);
@@ -43,6 +44,15 @@ exports.updateTestHistory = (appId, automation, history) => __awaiter(void 0, vo
         return metadata;
     });
 });
+exports.removeDeprecated = definitions => {
+    const base = cloneDeep(definitions);
+    for (let key of Object.keys(base)) {
+        if (base[key].deprecated) {
+            delete base[key];
+        }
+    }
+    return base;
+};
 // end the repetition and the job itself
 exports.disableAllCrons = (appId) => __awaiter(void 0, void 0, void 0, function* () {
     const promises = [];

package/dist/db/utils.js

@@ -28,6 +28,7 @@ const DocumentTypes = {
     DEPLOYMENTS: "deployments",
     METADATA: "metadata",
     MEM_VIEW: "view",
+    USER_FLAG: "flag",
 };
 const ViewNames = {
     LINK: "by_link",
@@ -271,6 +272,13 @@ exports.getQueryParams = (datasourceId = null, otherProps = {}) => {
     }
     return getDocParams(DocumentTypes.QUERY, `${datasourceId}${SEPARATOR}`, otherProps);
 };
+/**
+ * Generates a new flag document ID.
+ * @returns {string} The ID of the flag document that was generated.
+ */
+exports.generateUserFlagID = userId => {
+    return `${DocumentTypes.USER_FLAG}${SEPARATOR}${userId}`;
+};
 exports.generateMetadataID = (type, entityId) => {
     return `${DocumentTypes.METADATA}${SEPARATOR}${type}${SEPARATOR}${entityId}`;
 };

package/dist/definitions/datasource.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FilterTypes = exports.IncludeRelationships = exports.SourceNames = exports.DatasourceFieldTypes = exports.QueryTypes = exports.SortDirection = exports.Operation = void 0;
+exports.AuthType = exports.FilterTypes = exports.IncludeRelationships = exports.SourceNames = exports.DatasourceFieldTypes = exports.QueryTypes = exports.SortDirection = exports.Operation = void 0;
 var Operation;
 (function (Operation) {
     Operation["CREATE"] = "CREATE";
@@ -66,3 +66,8 @@ var FilterTypes;
     FilterTypes["NOT_EMPTY"] = "notEmpty";
     FilterTypes["ONE_OF"] = "oneOf";
 })(FilterTypes = exports.FilterTypes || (exports.FilterTypes = {}));
+var AuthType;
+(function (AuthType) {
+    AuthType["BASIC"] = "basic";
+    AuthType["BEARER"] = "bearer";
+})(AuthType = exports.AuthType || (exports.AuthType = {}));