@budibase/server 1.0.80-alpha.1 → 1.0.80

package/dist/api/routes/public/tables.js

@@ -1,154 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const tables_1 = __importDefault(require("../../controllers/public/tables"));
-const Endpoint_1 = __importDefault(require("./utils/Endpoint"));
-const validators_1 = require("../utils/validators");
-const read = [], write = [];
-/**
- * @openapi
- * /tables:
- *   post:
- *     summary: Create a table
- *     description: Create a table, this could be internal or external.
- *     tags:
- *       - tables
- *     parameters:
- *       - $ref: '#/components/parameters/appId'
- *     requestBody:
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/table'
- *           examples:
- *             table:
- *               $ref: '#/components/examples/table'
- *     responses:
- *       200:
- *         description: Returns the created table, including the ID which has been generated for it. This can be
- *           internal or external data sources.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/tableOutput'
- *             examples:
- *               table:
- *                 $ref: '#/components/examples/table'
- */
-write.push(new Endpoint_1.default("post", "/tables", tables_1.default.create).addMiddleware(validators_1.tableValidator()));
-/**
- * @openapi
- * /tables/{tableId}:
- *   put:
- *     summary: Update a table
- *     description: Update a table, this could be internal or external.
- *     tags:
- *       - tables
- *     parameters:
- *       - $ref: '#/components/parameters/tableId'
- *       - $ref: '#/components/parameters/appId'
- *     requestBody:
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/table'
- *           examples:
- *             table:
- *               $ref: '#/components/examples/table'
- *     responses:
- *       200:
- *         description: Returns the updated table.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/tableOutput'
- *             examples:
- *               table:
- *                 $ref: '#/components/examples/table'
- */
-write.push(new Endpoint_1.default("put", "/tables/:tableId", tables_1.default.update).addMiddleware(validators_1.tableValidator()));
-/**
- * @openapi
- * /tables/{tableId}:
- *   delete:
- *     summary: Delete a table
- *     description: Delete a table, this could be internal or external.
- *     tags:
- *       - tables
- *     parameters:
- *       - $ref: '#/components/parameters/tableId'
- *       - $ref: '#/components/parameters/appId'
- *     responses:
- *       200:
- *         description: Returns the deleted table.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/tableOutput'
- *             examples:
- *               table:
- *                 $ref: '#/components/examples/table'
- */
-write.push(new Endpoint_1.default("delete", "/tables/:tableId", tables_1.default.destroy));
-/**
- * @openapi
- * /tables/{tableId}:
- *   get:
- *     summary: Retrieve a table
- *     description: Lookup a table, this could be internal or external.
- *     tags:
- *       - tables
- *     parameters:
- *       - $ref: '#/components/parameters/tableId'
- *       - $ref: '#/components/parameters/appId'
- *     responses:
- *       200:
- *         description: Returns the retrieved table.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/tableOutput'
- *             examples:
- *               table:
- *                 $ref: '#/components/examples/table'
- */
-read.push(new Endpoint_1.default("get", "/tables/:tableId", tables_1.default.read));
-/**
- * @openapi
- * /tables/search:
- *   post:
- *     summary: Search for tables
- *     description: Based on table properties (currently only name) search for tables. This could be
- *       an internal or an external table.
- *     tags:
- *       - tables
- *     parameters:
- *       - $ref: '#/components/parameters/appId'
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/nameSearch'
- *     responses:
- *       200:
- *         description: Returns the found tables, based on the search parameters.
- *         content:
- *           application/json:
- *             schema:
- *               type: object
- *               required:
- *                 - data
- *               properties:
- *                 data:
- *                   type: array
- *                   items:
- *                     $ref: '#/components/schemas/table'
- *             examples:
- *               tables:
- *                 $ref: '#/components/examples/tables'
- */
-read.push(new Endpoint_1.default("post", "/tables/search", tables_1.default.search).addMiddleware(validators_1.nameValidator()));
-exports.default = { read, write };

package/dist/api/routes/public/users.js

@@ -1,137 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const users_1 = __importDefault(require("../../controllers/public/users"));
-const Endpoint_1 = __importDefault(require("./utils/Endpoint"));
-const validators_1 = require("../utils/validators");
-const read = [], write = [];
-/**
- * @openapi
- * /users:
- *   post:
- *     summary: Create a user
- *     tags:
- *       - users
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/user'
- *     responses:
- *       200:
- *         description: Returns the created user.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/userOutput'
- *             examples:
- *               user:
- *                 $ref: '#/components/examples/user'
- */
-write.push(new Endpoint_1.default("post", "/users", users_1.default.create));
-/**
- * @openapi
- * /users/{userId}:
- *   put:
- *     summary: Update a user
- *     tags:
- *       - users
- *     parameters:
- *       - $ref: '#/components/parameters/userId'
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/user'
- *     responses:
- *       200:
- *         description: Returns the updated user.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/userOutput'
- *             examples:
- *               user:
- *                 $ref: '#/components/examples/user'
- */
-write.push(new Endpoint_1.default("put", "/users/:userId", users_1.default.update));
-/**
- * @openapi
- * /users/{userId}:
- *   delete:
- *     summary: Delete a user
- *     tags:
- *       - users
- *     parameters:
- *       - $ref: '#/components/parameters/userId'
- *     responses:
- *       200:
- *         description: Returns the deleted user.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/userOutput'
- *             examples:
- *               user:
- *                 $ref: '#/components/examples/user'
- */
-write.push(new Endpoint_1.default("delete", "/users/:userId", users_1.default.destroy));
-/**
- * @openapi
- * /users/{userId}:
- *   get:
- *     summary: Retrieve a user
- *     tags:
- *       - users
- *     parameters:
- *       - $ref: '#/components/parameters/userId'
- *     responses:
- *       200:
- *         description: Returns the retrieved user.
- *         content:
- *           application/json:
- *             schema:
- *               $ref: '#/components/schemas/userOutput'
- *             examples:
- *               user:
- *                 $ref: '#/components/examples/user'
- */
-read.push(new Endpoint_1.default("get", "/users/:userId", users_1.default.read));
-/**
- * @openapi
- * /users/search:
- *   post:
- *     summary: Search for users
- *     description: Based on user properties (currently only name) search for users.
- *     tags:
- *       - users
- *     requestBody:
- *       required: true
- *       content:
- *         application/json:
- *           schema:
- *             $ref: '#/components/schemas/nameSearch'
- *     responses:
- *       200:
- *         description: Returns the found users based on search parameters.
- *         content:
- *           application/json:
- *             schema:
- *               type: object
- *               required:
- *                 - data
- *               properties:
- *                 data:
- *                   type: array
- *                   items:
- *                     $ref: '#/components/schemas/user'
- *             examples:
- *               users:
- *                 $ref: '#/components/examples/users'
- */
-read.push(new Endpoint_1.default("post", "/users/search", users_1.default.search).addMiddleware(validators_1.nameValidator()));
-exports.default = { read, write };

package/dist/api/routes/public/utils/Endpoint.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class Endpoint {
-    constructor(method, url, controller) {
-        this.method = method;
-        this.url = url;
-        this.controller = controller;
-        this.middlewares = [];
-        this.outputMiddlewares = [];
-    }
-    addMiddleware(middleware) {
-        this.middlewares.push(middleware);
-        return this;
-    }
-    addOutputMiddleware(middleware) {
-        this.outputMiddlewares.push(middleware);
-        return this;
-    }
-    apply(router) {
-        const method = this.method, url = this.url;
-        const middlewares = this.middlewares, controller = this.controller, outputMiddlewares = this.outputMiddlewares;
-        // need a function to do nothing to stop the execution at the end
-        // middlewares are circular so if they always keep calling next, it'll just keep looping
-        const complete = () => { };
-        const params = [
-            url,
-            ...middlewares,
-            controller,
-            ...outputMiddlewares,
-            complete,
-        ];
-        // @ts-ignore
-        router[method](...params);
-    }
-}
-exports.default = Endpoint;

package/dist/api/routes/utils/validators.js

@@ -1,200 +0,0 @@
-"use strict";
-const joiValidator = require("../../../middleware/joi-validator");
-const { DataSourceOperation } = require("../../../constants");
-const { WebhookType } = require("../../../constants");
-const { BUILTIN_PERMISSION_IDS, PermissionLevels, } = require("@budibase/backend-core/permissions");
-const Joi = require("joi");
-const OPTIONAL_STRING = Joi.string().optional().allow(null).allow("");
-const OPTIONAL_NUMBER = Joi.number().optional().allow(null);
-exports.tableValidator = () => {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        _id: OPTIONAL_STRING,
-        _rev: OPTIONAL_STRING,
-        type: OPTIONAL_STRING.valid("table", "internal", "external"),
-        primaryDisplay: OPTIONAL_STRING,
-        schema: Joi.object().required(),
-        name: Joi.string().required(),
-        views: Joi.object(),
-        dataImport: Joi.object(),
-    }).unknown(true));
-};
-exports.nameValidator = () => {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        name: OPTIONAL_STRING,
-    }));
-};
-exports.datasourceValidator = () => {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        _id: Joi.string(),
-        _rev: Joi.string(),
-        type: OPTIONAL_STRING.allow("datasource_plus"),
-        relationships: Joi.array().items(Joi.object({
-            from: Joi.string().required(),
-            to: Joi.string().required(),
-            cardinality: Joi.valid("1:N", "1:1", "N:N").required()
-        })),
-    }).unknown(true));
-};
-function filterObject() {
-    // prettier-ignore
-    return Joi.object({
-        string: Joi.object().optional(),
-        fuzzy: Joi.object().optional(),
-        range: Joi.object().optional(),
-        equal: Joi.object().optional(),
-        notEqual: Joi.object().optional(),
-        empty: Joi.object().optional(),
-        notEmpty: Joi.object().optional(),
-        oneOf: Joi.object().optional(),
-        contains: Joi.object().optional(),
-        notContains: Joi.object().optional(),
-    }).unknown(true);
-}
-exports.internalSearchValidator = () => {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        tableId: OPTIONAL_STRING,
-        query: filterObject(),
-        limit: OPTIONAL_NUMBER,
-        sort: OPTIONAL_STRING,
-        sortOrder: OPTIONAL_STRING,
-        sortType: OPTIONAL_STRING,
-        paginate: Joi.boolean(),
-        bookmark: Joi.alternatives().try(OPTIONAL_STRING, OPTIONAL_NUMBER).optional(),
-    }));
-};
-exports.externalSearchValidator = () => {
-    return joiValidator.body(Joi.object({
-        query: filterObject(),
-        paginate: Joi.boolean().optional(),
-        bookmark: Joi.alternatives()
-            .try(OPTIONAL_STRING, OPTIONAL_NUMBER)
-            .optional(),
-        limit: OPTIONAL_NUMBER,
-        sort: Joi.object({
-            column: Joi.string(),
-            order: OPTIONAL_STRING.valid("ascending", "descending"),
-            type: OPTIONAL_STRING.valid("string", "number"),
-        }).optional(),
-    }));
-};
-exports.datasourceQueryValidator = () => {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        endpoint: Joi.object({
-            datasourceId: Joi.string().required(),
-            operation: Joi.string().required().valid(...Object.values(DataSourceOperation)),
-            entityId: Joi.string().required(),
-        }).required(),
-        resource: Joi.object({
-            fields: Joi.array().items(Joi.string()).optional(),
-        }).optional(),
-        body: Joi.object().optional(),
-        sort: Joi.object().optional(),
-        filters: filterObject().optional(),
-        paginate: Joi.object({
-            page: Joi.string().alphanum().optional(),
-            limit: Joi.number().optional(),
-        }).optional(),
-    }));
-};
-exports.webhookValidator = () => {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        live: Joi.bool(),
-        _id: OPTIONAL_STRING,
-        _rev: OPTIONAL_STRING,
-        name: Joi.string().required(),
-        bodySchema: Joi.object().optional(),
-        action: Joi.object({
-            type: Joi.string().required().valid(WebhookType.AUTOMATION),
-            target: Joi.string().required(),
-        }).required(),
-    }).unknown(true));
-};
-exports.roleValidator = () => {
-    const permLevelArray = Object.values(PermissionLevels);
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        _id: OPTIONAL_STRING,
-        _rev: OPTIONAL_STRING,
-        name: Joi.string().required(),
-        // this is the base permission ID (for now a built in)
-        permissionId: Joi.string().valid(...Object.values(BUILTIN_PERMISSION_IDS)).required(),
-        permissions: Joi.object()
-            .pattern(/.*/, [Joi.string().valid(...permLevelArray)])
-            .optional(),
-        inherits: OPTIONAL_STRING,
-    }).unknown(true));
-};
-exports.permissionValidator = () => {
-    const permLevelArray = Object.values(PermissionLevels);
-    // prettier-ignore
-    return joiValidator.params(Joi.object({
-        level: Joi.string().valid(...permLevelArray).required(),
-        resourceId: Joi.string(),
-        roleId: Joi.string(),
-    }).unknown(true));
-};
-exports.screenValidator = () => {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        name: Joi.string().required(),
-        routing: Joi.object({
-            route: Joi.string().required(),
-            roleId: Joi.string().required().allow(""),
-        }).required().unknown(true),
-        props: Joi.object({
-            _id: Joi.string().required(),
-            _component: Joi.string().required(),
-            _children: Joi.array().required(),
-            _instanceName: Joi.string().required(),
-            _styles: Joi.object().required(),
-            type: OPTIONAL_STRING,
-            table: OPTIONAL_STRING,
-            layoutId: OPTIONAL_STRING,
-        }).required().unknown(true),
-    }).unknown(true));
-};
-function generateStepSchema(allowStepTypes) {
-    // prettier-ignore
-    return Joi.object({
-        stepId: Joi.string().required(),
-        id: Joi.string().required(),
-        description: Joi.string().required(),
-        name: Joi.string().required(),
-        tagline: Joi.string().required(),
-        icon: Joi.string().required(),
-        params: Joi.object(),
-        args: Joi.object(),
-        type: Joi.string().required().valid(...allowStepTypes),
-    }).unknown(true);
-}
-exports.automationValidator = (existing = false) => {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        _id: existing ? Joi.string().required() : OPTIONAL_STRING,
-        _rev: existing ? Joi.string().required() : OPTIONAL_STRING,
-        name: Joi.string().required(),
-        type: Joi.string().valid("automation").required(),
-        definition: Joi.object({
-            steps: Joi.array().required().items(generateStepSchema(["ACTION", "LOGIC"])),
-            trigger: generateStepSchema(["TRIGGER"]).allow(null),
-        }).required().unknown(true),
-    }).unknown(true));
-};
-exports.applicationValidator = () => {
-    // prettier-ignore
-    return joiValidator.body(Joi.object({
-        _id: OPTIONAL_STRING,
-        _rev: OPTIONAL_STRING,
-        name: Joi.string().required(),
-        url: OPTIONAL_STRING,
-        template: Joi.object({
-            templateString: OPTIONAL_STRING,
-        }).unknown(true),
-    }).unknown(true));
-};

package/dist/definitions/openapi.js

@@ -1,6 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/specs/generate.js

@@ -1,83 +0,0 @@
-const swaggerJsdoc = require("swagger-jsdoc")
-const { join } = require("path")
-const { writeFileSync } = require("fs")
-const { examples, schemas } = require("./resources")
-const parameters = require("./parameters")
-const security = require("./security")
-
-const VARIABLES = {}
-
-const options = {
-  definition: {
-    openapi: "3.0.0",
-    info: {
-      title: "Budibase API",
-      description: "The public API for Budibase apps and its services.",
-      version: "1.0.0",
-    },
-    servers: [
-      {
-        url: "http://budibase.app/api/public/v1",
-        description: "Budibase Cloud API",
-      },
-      {
-        url: "{protocol}://{hostname}:10000/api/public/v1",
-        description: "Budibase self hosted API",
-      },
-    ],
-    components: {
-      parameters: {
-        ...parameters,
-      },
-      examples: {
-        ...examples,
-      },
-      securitySchemes: {
-        ...security,
-      },
-      schemas: {
-        ...schemas,
-      },
-    },
-    security: [
-      {
-        ApiKeyAuth: [],
-      },
-    ],
-  },
-  format: ".json",
-  apis: [join(__dirname, "..", "src", "api", "routes", "public", "*.ts")],
-}
-
-function writeFile(output, filename) {
-  try {
-    const path = join(__dirname, filename)
-    let spec = output
-    if (filename.endsWith("json")) {
-      spec = JSON.stringify(output, null, 2)
-    }
-    // input the static variables
-    for (let [key, replacement] of Object.entries(VARIABLES)) {
-      spec = spec.replace(new RegExp(`{${key}}`, "g"), replacement)
-    }
-    writeFileSync(path, spec)
-    console.log(`Wrote spec to ${path}`)
-    return path
-  } catch (err) {
-    console.error(err)
-  }
-}
-
-function run() {
-  const outputJSON = swaggerJsdoc(options)
-  options.format = ".yaml"
-  const outputYAML = swaggerJsdoc(options)
-  writeFile(outputJSON, "openapi.json")
-  return writeFile(outputYAML, "openapi.yaml")
-}
-
-if (require.main === module) {
-  run()
-}
-
-module.exports = run