@budibase/server 1.0.80-alpha.1 → 1.0.80

package/src/api/routes/public/users.ts

@@ -1,144 +0,0 @@
-import controller from "../../controllers/public/users"
-import Endpoint from "./utils/Endpoint"
-import { nameValidator } from "../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("post", "/users", controller.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("put", "/users/:userId", controller.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("delete", "/users/:userId", controller.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("get", "/users/:userId", controller.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("post", "/users/search", controller.search).addMiddleware(
-    nameValidator()
-  )
-)
-
-export default { read, write }

package/src/api/routes/public/utils/Endpoint.ts

@@ -1,51 +0,0 @@
-import Router from "koa-router"
-
-export type CtxFn = (ctx: any, next?: any) => void | Promise<any>
-
-class Endpoint {
-  method: string
-  url: string
-  controller: CtxFn
-  middlewares: CtxFn[]
-  outputMiddlewares: CtxFn[]
-
-  constructor(method: string, url: string, controller: CtxFn) {
-    this.method = method
-    this.url = url
-    this.controller = controller
-    this.middlewares = []
-    this.outputMiddlewares = []
-  }
-
-  addMiddleware(middleware: CtxFn) {
-    this.middlewares.push(middleware)
-    return this
-  }
-
-  addOutputMiddleware(middleware: CtxFn) {
-    this.outputMiddlewares.push(middleware)
-    return this
-  }
-
-  apply(router: 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)
-  }
-}
-
-export default Endpoint

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

@@ -1,219 +0,0 @@
-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))
-}