@budibase/server 2.3.18-alpha.17 → 2.3.18-alpha.19

package/specs/resources/{user.js → user.ts}

@@ -1,5 +1,5 @@
-const { object } = require("./utils")
-const Resource = require("./utils/Resource")
+import { object } from "./utils"
+import Resource from "./utils/Resource"
 
 const user = {
   _id: "us_693a73206518477283a8d5ae31103252",
@@ -105,7 +105,7 @@ const userOutputSchema = {
   required: [...userSchema.required, "_id"],
 }
 
-module.exports = new Resource()
+export default new Resource()
   .setExamples({
     user: {
       value: {

package/specs/resources/utils/Resource.ts

@@ -0,0 +1,39 @@
+type Example = {
+  [key: string]: {
+    [key: string]: any
+  }
+}
+
+type Schema = {
+  [key: string]: {
+    [key: string]: any
+  }
+}
+
+export default class Resource {
+  examples: Example
+  schemas: Schema
+
+  constructor() {
+    this.examples = {}
+    this.schemas = {}
+  }
+
+  setExamples(examples: Example) {
+    this.examples = examples
+    return this
+  }
+
+  setSchemas(schemas: Schema) {
+    this.schemas = schemas
+    return this
+  }
+
+  getExamples() {
+    return this.examples
+  }
+
+  getSchemas() {
+    return this.schemas
+  }
+}

package/specs/resources/utils/{index.js → index.ts}

@@ -1,4 +1,4 @@
-exports.object = (props, opts) => {
+export const object = (props: any, opts?: any) => {
   const base = {
     type: "object",
     properties: props,

package/specs/{security.js → security.ts}

@@ -1,4 +1,4 @@
-exports.ApiKeyAuth = {
+export const ApiKeyAuth = {
   type: "apiKey",
   in: "header",
   name: "x-budibase-api-key",

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

@@ -9,7 +9,7 @@ const read = [],
  * @openapi
  * /applications:
  *   post:
- *     operationId: create
+ *     operationId: appCreate
  *     summary: Create an application
  *     tags:
  *       - applications
@@ -42,7 +42,7 @@ write.push(
  * @openapi
  * /applications/{appId}:
  *   put:
- *     operationId: update
+ *     operationId: appUpdate
  *     summary: Update an application
  *     tags:
  *       - applications
@@ -75,7 +75,7 @@ write.push(
  * @openapi
  * /applications/{appId}:
  *   delete:
- *     operationId: destroy
+ *     operationId: appDestroy
  *     summary: Delete an application
  *     tags:
  *       - applications
@@ -98,7 +98,7 @@ write.push(new Endpoint("delete", "/applications/:appId", controller.destroy))
  * @openapi
  * /applications/{appId}/unpublish:
  *   post:
- *     operationId: unpublish
+ *     operationId: appUnpublish
  *     summary: Unpublish an application
  *     tags:
  *       - applications
@@ -116,7 +116,7 @@ write.push(
  * @openapi
  * /applications/{appId}/publish:
  *   post:
- *     operationId: publish
+ *     operationId: appPublish
  *     summary: Unpublish an application
  *     tags:
  *       - applications
@@ -141,7 +141,7 @@ write.push(
  * @openapi
  * /applications/{appId}:
  *   get:
- *     operationId: getById
+ *     operationId: appGetById
  *     summary: Retrieve an application
  *     tags:
  *       - applications
@@ -164,7 +164,7 @@ read.push(new Endpoint("get", "/applications/:appId", controller.read))
  * @openapi
  * /applications/search:
  *   post:
- *     operationId: search
+ *     operationId: appSearch
  *     summary: Search for applications
  *     description: Based on application properties (currently only name) search for applications.
  *     tags:

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

@@ -9,7 +9,7 @@ const read = [],
  * @openapi
  * /queries/{queryId}:
  *   post:
- *     operationId: execute
+ *     operationId: queryExecute
  *     summary: Execute a query
  *     description: Queries which have been created within a Budibase app can be executed using this,
  *     tags:
@@ -43,7 +43,7 @@ write.push(new Endpoint("post", "/queries/:queryId", controller.execute))
  * @openapi
  * /queries/search:
  *   post:
- *     operationId: search
+ *     operationId: querySearch
  *     summary: Search for queries
  *     description: Based on query properties (currently only name) search for queries.
  *     tags:

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

@@ -9,7 +9,7 @@ const read = [],
  * @openapi
  * /tables/{tableId}/rows:
  *   post:
- *     operationId: create
+ *     operationId: rowCreate
  *     summary: Create a row
  *     description: Creates a row within the specified table.
  *     tags:
@@ -44,7 +44,7 @@ write.push(new Endpoint("post", "/tables/:tableId/rows", controller.create))
  * @openapi
  * /tables/{tableId}/rows/{rowId}:
  *   put:
- *     operationId: update
+ *     operationId: rowUpdate
  *     summary: Update a row
  *     description: Updates a row within the specified table.
  *     tags:
@@ -81,7 +81,7 @@ write.push(
  * @openapi
  * /tables/{tableId}/rows/{rowId}:
  *   delete:
- *     operationId: destroy
+ *     operationId: rowDestroy
  *     summary: Delete a row
  *     description: Deletes a row within the specified table.
  *     tags:
@@ -109,7 +109,7 @@ write.push(
  * @openapi
  * /tables/{tableId}/rows/{rowId}:
  *   get:
- *     operationId: getById
+ *     operationId: rowGetById
  *     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.
@@ -136,7 +136,7 @@ read.push(new Endpoint("get", "/tables/:tableId/rows/:rowId", controller.read))
  * @openapi
  * /tables/{tableId}/rows/search:
  *   post:
- *     operationId: search
+ *     operationId: rowSearch
  *     summary: Search for rows
  *     tags:
  *       - rows

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

@@ -9,7 +9,7 @@ const read = [],
  * @openapi
  * /tables:
  *   post:
- *     operationId: create
+ *     operationId: tableCreate
  *     summary: Create a table
  *     description: Create a table, this could be internal or external.
  *     tags:
@@ -46,7 +46,7 @@ write.push(
  * @openapi
  * /tables/{tableId}:
  *   put:
- *     operationId: update
+ *     operationId: tableUpdate
  *     summary: Update a table
  *     description: Update a table, this could be internal or external.
  *     tags:
@@ -83,7 +83,7 @@ write.push(
  * @openapi
  * /tables/{tableId}:
  *   delete:
- *     operationId: destroy
+ *     operationId: tableDestroy
  *     summary: Delete a table
  *     description: Delete a table, this could be internal or external.
  *     tags:
@@ -108,7 +108,7 @@ write.push(new Endpoint("delete", "/tables/:tableId", controller.destroy))
  * @openapi
  * /tables/{tableId}:
  *   get:
- *     operationId: getById
+ *     operationId: tableGetById
  *     summary: Retrieve a table
  *     description: Lookup a table, this could be internal or external.
  *     tags:
@@ -133,7 +133,7 @@ read.push(new Endpoint("get", "/tables/:tableId", controller.read))
  * @openapi
  * /tables/search:
  *   post:
- *     operationId: search
+ *     operationId: tableSearch
  *     summary: Search for tables
  *     description: Based on table properties (currently only name) search for tables. This could be
  *       an internal or an external table.

package/src/api/routes/public/tests/{compare.spec.js → compare.spec.ts}

@@ -1,13 +1,14 @@
-const jestOpenAPI = require("jest-openapi").default
-const generateSchema = require("../../../../../specs/generate")
-const setup = require("../../tests/utilities")
-const { generateMakeRequest } = require("./utils")
+import jestOpenAPI from "jest-openapi"
+import { run as generateSchema } from "../../../../../specs/generate"
+import * as setup from "../../tests/utilities"
+import { generateMakeRequest } from "./utils"
+import { Table, App, Row, User } from "@budibase/types"
 
 const yamlPath = generateSchema()
-jestOpenAPI(yamlPath)
+jestOpenAPI(yamlPath!)
 
 let config = setup.getConfig()
-let apiKey, table, app, makeRequest
+let apiKey: string, table: Table, app: App, makeRequest: any
 
 beforeAll(async () => {
   app = await config.init()
@@ -25,19 +26,29 @@ describe("check the applications endpoints", () => {
   })
 
   it("should allow creating an application", async () => {
-    const res = await makeRequest("post", "/applications", {
-      name: "new App"
-    }, null)
+    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)
+    const res = await makeRequest(
+      "put",
+      `/applications/${appId}`,
+      {
+        ...app,
+        name: "updated app name",
+      },
+      appId
+    )
     expect(res).toSatisfyApiSpec()
   })
 
@@ -47,7 +58,10 @@ describe("check the applications endpoints", () => {
   })
 
   it("should allow deleting an application", async () => {
-    const res = await makeRequest("delete", `/applications/${config.getAppId()}`)
+    const res = await makeRequest(
+      "delete",
+      `/applications/${config.getAppId()}`
+    )
     expect(res).toSatisfyApiSpec()
   })
 })
@@ -68,8 +82,8 @@ describe("check the tables endpoints", () => {
         column1: {
           type: "string",
           constraints: {},
-        }
-      }
+        },
+      },
     })
     expect(res).toSatisfyApiSpec()
   })
@@ -92,12 +106,11 @@ describe("check the tables endpoints", () => {
 })
 
 describe("check the rows endpoints", () => {
-  let row
+  let row: Row
   it("should allow retrieving rows through search", async () => {
     table = await config.updateTable()
     const res = await makeRequest("post", `/tables/${table._id}/rows/search`, {
-      query: {
-      },
+      query: {},
     })
     expect(res).toSatisfyApiSpec()
   })
@@ -111,9 +124,13 @@ describe("check the rows endpoints", () => {
   })
 
   it("should allow updating a row", async () => {
-    const res = await makeRequest("put", `/tables/${table._id}/rows/${row._id}`, {
-      name: "test row updated",
-    })
+    const res = await makeRequest(
+      "put",
+      `/tables/${table._id}/rows/${row._id}`,
+      {
+        name: "test row updated",
+      }
+    )
     expect(res).toSatisfyApiSpec()
   })
 
@@ -123,13 +140,16 @@ describe("check the rows endpoints", () => {
   })
 
   it("should allow deleting a row", async () => {
-    const res = await makeRequest("delete", `/tables/${table._id}/rows/${row._id}`)
+    const res = await makeRequest(
+      "delete",
+      `/tables/${table._id}/rows/${row._id}`
+    )
     expect(res).toSatisfyApiSpec()
   })
 })
 
 describe("check the users endpoints", () => {
-  let user
+  let user: User
   it("should allow retrieving users through search", async () => {
     user = await config.createUser()
     const res = await makeRequest("post", "/users/search")
@@ -163,4 +183,3 @@ describe("check the queries endpoints", () => {
     expect(res).toSatisfyApiSpec()
   })
 })
-

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

@@ -9,7 +9,7 @@ const read = [],
  * @openapi
  * /users:
  *   post:
- *     operationId: create
+ *     operationId: userCreate
  *     summary: Create a user
  *     tags:
  *       - users
@@ -36,7 +36,7 @@ write.push(new Endpoint("post", "/users", controller.create))
  * @openapi
  * /users/{userId}:
  *   put:
- *     operationId: update
+ *     operationId: userUpdate
  *     summary: Update a user
  *     tags:
  *       - users
@@ -65,7 +65,7 @@ write.push(new Endpoint("put", "/users/:userId", controller.update))
  * @openapi
  * /users/{userId}:
  *   delete:
- *     operationId: destroy
+ *     operationId: userDestroy
  *     summary: Delete a user
  *     tags:
  *       - users
@@ -88,7 +88,7 @@ write.push(new Endpoint("delete", "/users/:userId", controller.destroy))
  * @openapi
  * /users/{userId}:
  *   get:
- *     operationId: getById
+ *     operationId: userGetById
  *     summary: Retrieve a user
  *     tags:
  *       - users
@@ -111,7 +111,7 @@ read.push(new Endpoint("get", "/users/:userId", controller.read))
  * @openapi
  * /users/search:
  *   post:
- *     operationId: search
+ *     operationId: userSearch
  *     summary: Search for users
  *     description: Based on user properties (currently only name) search for users.
  *     tags: