@budibase/server 1.0.78 → 1.0.79-alpha.10

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

@@ -0,0 +1,81 @@
+import controller from "../../controllers/public/queries"
+import Endpoint from "./utils/Endpoint"
+import { nameValidator } from "../utils/validators"
+
+const read = [],
+  write = []
+
+/**
+ * @openapi
+ * /queries/{queryId}:
+ *   post:
+ *     summary: Execute a query
+ *     description: Queries which have been created within a Budibase app can be executed using this,
+ *     tags:
+ *       - queries
+ *     parameters:
+ *       - $ref: '#/components/parameters/queryId'
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/executeQuery'
+ *     responses:
+ *       200:
+ *         description: Returns the result of the query execution.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/executeQueryOutput'
+ *             examples:
+ *               REST:
+ *                 $ref: '#/components/examples/restResponse'
+ *               SQL:
+ *                 $ref: '#/components/examples/sqlResponse'
+ *
+ */
+write.push(new Endpoint("post", "/queries/:queryId", controller.execute))
+
+/**
+ * @openapi
+ * /queries/search:
+ *   post:
+ *     summary: Search for queries
+ *     description: Based on query properties (currently only name) search for queries.
+ *     tags:
+ *       - queries
+ *     parameters:
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/nameSearch'
+ *     responses:
+ *       200:
+ *         description: Returns the queries found based on the search parameters.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - data
+ *               properties:
+ *                 data:
+ *                   type: array
+ *                   items:
+ *                     $ref: '#/components/schemas/query'
+ *             examples:
+ *               queries:
+ *                 $ref: '#/components/examples/queries'
+ */
+read.push(
+  new Endpoint("post", "/queries/search", controller.search).addMiddleware(
+    nameValidator()
+  )
+)
+
+export default { read, write }

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

@@ -0,0 +1,242 @@
+import controller from "../../controllers/public/rows"
+import Endpoint from "./utils/Endpoint"
+import { externalSearchValidator } from "../utils/validators"
+
+const read = [],
+  write = []
+
+/**
+ * @openapi
+ * /tables/{tableId}/rows:
+ *   post:
+ *     summary: Create a row
+ *     description: Creates a row within the specified table.
+ *     tags:
+ *       - rows
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/row'
+ *           examples:
+ *             row:
+ *               $ref: '#/components/examples/inputRow'
+ *     responses:
+ *       200:
+ *         description: Returns the created row, including the ID which has been generated for it.
+ *           This can be found in the Budibase portal, viewed under the developer information.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/rowOutput'
+ *             examples:
+ *               row:
+ *                 $ref: '#/components/examples/row'
+ */
+write.push(new Endpoint("post", "/tables/:tableId/rows", controller.create))
+
+/**
+ * @openapi
+ * /tables/{tableId}/rows/{rowId}:
+ *   put:
+ *     summary: Update a row
+ *     description: Updates a row within the specified table.
+ *     tags:
+ *       - rows
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/rowId'
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/row'
+ *           examples:
+ *             row:
+ *               $ref: '#/components/examples/inputRow'
+ *     responses:
+ *       200:
+ *         description: Returns the created row, including the ID which has been generated for it.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/rowOutput'
+ *             examples:
+ *               row:
+ *                 $ref: '#/components/examples/row'
+ */
+write.push(
+  new Endpoint("put", "/tables/:tableId/rows/:rowId", controller.update)
+)
+
+/**
+ * @openapi
+ * /tables/{tableId}/rows/{rowId}:
+ *   delete:
+ *     summary: Delete a row
+ *     description: Deletes a row within the specified table.
+ *     tags:
+ *       - rows
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/rowId'
+ *       - $ref: '#/components/parameters/appId'
+ *     responses:
+ *       200:
+ *         description: Returns the deleted row, including the ID which has been generated for it.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/rowOutput'
+ *             examples:
+ *               row:
+ *                 $ref: '#/components/examples/row'
+ */
+write.push(
+  new Endpoint("delete", "/tables/:tableId/rows/:rowId", controller.destroy)
+)
+
+/**
+ * @openapi
+ * /tables/{tableId}/rows/{rowId}:
+ *   get:
+ *     summary: Retrieve a row
+ *     description: This gets a single row, it will be enriched with the full related rows, rather than
+ *       the squashed "primaryDisplay" format returned by the search endpoint.
+ *     tags:
+ *       - rows
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/rowId'
+ *       - $ref: '#/components/parameters/appId'
+ *     responses:
+ *       200:
+ *         description: Returns the retrieved row.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/rowOutput'
+ *             examples:
+ *               enrichedRow:
+ *                 $ref: '#/components/examples/enrichedRow'
+ */
+read.push(new Endpoint("get", "/tables/:tableId/rows/:rowId", controller.read))
+
+/**
+ * @openapi
+ * /tables/{tableId}/rows/search:
+ *   post:
+ *     summary: Search for rows
+ *     tags:
+ *       - rows
+ *     parameters:
+ *       - $ref: '#/components/parameters/tableId'
+ *       - $ref: '#/components/parameters/appId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required:
+ *               - query
+ *             properties:
+ *               query:
+ *                 type: object
+ *                 properties:
+ *                   string:
+ *                     type: object
+ *                     example:
+ *                       columnName1: value
+ *                       columnName2: value
+ *                     description: A map of field name to the string to search for,
+ *                       this will look for rows that have a value starting with the
+ *                       string value.
+ *                     additionalProperties:
+ *                       type: string
+ *                       description: The value to search for in the column.
+ *                   fuzzy:
+ *                     type: object
+ *                     description: A fuzzy search, only supported by internal tables.
+ *                   range:
+ *                     type: object
+ *                     description: Searches within a range, the format of this must be
+ *                       columnName -> [low, high].
+ *                     example:
+ *                       columnName1: [10, 20]
+ *                   equal:
+ *                     type: object
+ *                     description: Searches for rows that have a column value that is
+ *                       exactly the value set.
+ *                   notEqual:
+ *                     type: object
+ *                     description: Searches for any row which does not contain the specified
+ *                       column value.
+ *                   empty:
+ *                     type: object
+ *                     description: Searches for rows which do not contain the specified column.
+ *                       The object should simply contain keys of the column names, these
+ *                       can map to any value.
+ *                     example:
+ *                       columnName1: ""
+ *                   notEmpty:
+ *                     type: object
+ *                     description: Searches for rows which have the specified column.
+ *                   oneOf:
+ *                     type: object
+ *                     description: Searches for rows which have a column value that is any
+ *                       of the specified values. The format of this must be columnName -> [value1, value2].
+ *               paginate:
+ *                 type: boolean
+ *                 description: Enables pagination, by default this is disabled.
+ *               bookmark:
+ *                 oneOf:
+ *                   - type: string
+ *                   - type: integer
+ *                 description: If retrieving another page, the bookmark from the previous request must be supplied.
+ *               limit:
+ *                 type: integer
+ *                 description: The maximum number of rows to return, useful when paginating, for internal tables this
+ *                   will be limited to 1000, for SQL tables it will be 5000.
+ *               sort:
+ *                 type: object
+ *                 description: A set of parameters describing the sort behaviour of the search.
+ *                 properties:
+ *                   order:
+ *                     type: string
+ *                     enum: [ascending, descending]
+ *                     description: The order of the sort, by default this is ascending.
+ *                   column:
+ *                     type: string
+ *                     description: The name of the column by which the rows will be sorted.
+ *                   type:
+ *                     type: string
+ *                     enum: [string, number]
+ *                     description: Defines whether the column should be treated as a string
+ *                       or as numbers when sorting.
+ *     responses:
+ *       200:
+ *         description: The response will contain an array of rows that match the search parameters.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/searchOutput'
+ *             examples:
+ *               search:
+ *                 $ref: '#/components/examples/rows'
+ */
+read.push(
+  new Endpoint(
+    "post",
+    "/tables/:tableId/rows/search",
+    controller.search
+  ).addMiddleware(externalSearchValidator())
+)
+
+export default { read, write }

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

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

package/src/api/routes/public/tests/compare.spec.js

@@ -0,0 +1,184 @@
+const jestOpenAPI = require("jest-openapi").default
+const generateSchema = require("../../../../../specs/generate")
+const setup = require("../../tests/utilities")
+const { checkSlashesInUrl } = require("../../../../utilities")
+
+const yamlPath = generateSchema()
+jestOpenAPI(yamlPath)
+
+let request = setup.getRequest()
+let config = setup.getConfig()
+let apiKey, table, app
+
+beforeAll(async () => {
+  app = await config.init()
+  table = await config.updateTable()
+  apiKey = await config.generateApiKey()
+})
+
+afterAll(setup.afterAll)
+
+async function makeRequest(method, endpoint, body, appId = config.getAppId()) {
+  const extraHeaders = {
+    "x-budibase-api-key": apiKey,
+  }
+  if (appId) {
+    extraHeaders["x-budibase-app-id"] = appId
+  }
+  const req = request
+    [method](checkSlashesInUrl(`/api/public/v1/${endpoint}`))
+    .set(config.defaultHeaders(extraHeaders))
+  if (body) {
+    req.send(body)
+  }
+  const res = await req.expect("Content-Type", /json/).expect(200)
+  expect(res.body).toBeDefined()
+  return res
+}
+
+describe("check the applications endpoints", () => {
+  it("should allow retrieving applications through search", async () => {
+    const res = await makeRequest("post", "/applications/search")
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow creating an application", async () => {
+    const res = await makeRequest("post", "/applications", {
+      name: "new App"
+    }, null)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow updating an application", async () => {
+    const app = config.getApp()
+    const appId = config.getAppId()
+    const res = await makeRequest("put", `/applications/${appId}`, {
+      ...app,
+      name: "updated app name",
+    }, appId)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow retrieving an application", async () => {
+    const res = await makeRequest("get", `/applications/${config.getAppId()}`)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow deleting an application", async () => {
+    const res = await makeRequest("delete", `/applications/${config.getAppId()}`)
+    expect(res).toSatisfyApiSpec()
+  })
+})
+
+describe("check the tables endpoints", () => {
+  it("should allow retrieving tables through search", async () => {
+    await config.createApp("new app 1")
+    table = await config.updateTable()
+    const res = await makeRequest("post", "/tables/search")
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow creating a table", async () => {
+    const res = await makeRequest("post", "/tables", {
+      name: "table name",
+      primaryDisplay: "column1",
+      schema: {
+        column1: {
+          type: "string",
+          constraints: {},
+        }
+      }
+    })
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow updating a table", async () => {
+    const updated = { ...table, _rev: undefined, name: "new name" }
+    const res = await makeRequest("put", `/tables/${table._id}`, updated)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow retrieving a table", async () => {
+    const res = await makeRequest("get", `/tables/${table._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow deleting a table", async () => {
+    const res = await makeRequest("delete", `/tables/${table._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+})
+
+describe("check the rows endpoints", () => {
+  let row
+  it("should allow retrieving rows through search", async () => {
+    table = await config.updateTable()
+    const res = await makeRequest("post", `/tables/${table._id}/rows/search`, {
+      query: {
+      },
+    })
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow creating a row", async () => {
+    const res = await makeRequest("post", `/tables/${table._id}/rows`, {
+      name: "test row",
+    })
+    expect(res).toSatisfyApiSpec()
+    row = res.body.data
+  })
+
+  it("should allow updating a row", async () => {
+    const res = await makeRequest("put", `/tables/${table._id}/rows/${row._id}`, {
+      name: "test row updated",
+    })
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow retrieving a row", async () => {
+    const res = await makeRequest("get", `/tables/${table._id}/rows/${row._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow deleting a row", async () => {
+    const res = await makeRequest("delete", `/tables/${table._id}/rows/${row._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+})
+
+describe("check the users endpoints", () => {
+  let user
+  it("should allow retrieving users through search", async () => {
+    user = await config.createUser()
+    const res = await makeRequest("post", "/users/search")
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow creating a user", async () => {
+    const res = await makeRequest("post", "/users")
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow updating a user", async () => {
+    const res = await makeRequest("put", `/users/${user._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow retrieving a user", async () => {
+    const res = await makeRequest("get", `/users/${user._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow deleting a user", async () => {
+    const res = await makeRequest("delete", `/users/${user._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+})
+
+describe("check the queries endpoints", () => {
+  it("should allow retrieving queries through search", async () => {
+    const res = await makeRequest("post", "/queries/search")
+    expect(res).toSatisfyApiSpec()
+  })
+})
+