@budibase/server 2.3.18-alpha.2 → 2.3.18-alpha.21

package/jest.config.ts

@@ -39,6 +39,7 @@ const config: Config.InitialOptions = {
   ],
   collectCoverageFrom: [
     "src/**/*.{js,ts}",
+    "../backend-core/src/**/*.{js,ts}",
     // The use of coverage with couchdb view functions breaks tests
     "!src/db/views/staticViews.*",
   ],

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "2.3.18-alpha.2",
+  "version": "2.3.18-alpha.21",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -14,7 +14,7 @@
     "build:dev": "yarn prebuild && tsc --build --watch --preserveWatchOutput",
     "debug": "yarn build && node --expose-gc --inspect=9222 dist/index.js",
     "postbuild": "copyfiles -u 1 src/**/*.svelte dist/ && copyfiles -u 1 src/**/*.hbs dist/ && copyfiles -u 1 src/**/*.json dist/",
-    "test": "jest --coverage --runInBand",
+    "test": "bash scripts/test.sh",
     "test:watch": "jest --watch",
     "predocker": "copyfiles -f ../client/dist/budibase-client.js ../client/manifest.json client",
     "build:docker": "yarn run predocker && docker build . -t app-service --label version=$BUDIBASE_RELEASE_VERSION",
@@ -25,7 +25,7 @@
     "dev:stack:down": "node scripts/dev/manage.js down",
     "dev:stack:nuke": "node scripts/dev/manage.js nuke",
     "dev:builder": "yarn run dev:stack:up && nodemon",
-    "specs": "node specs/generate.js && openapi-typescript specs/openapi.yaml --output src/definitions/openapi.ts",
+    "specs": "ts-node specs/generate.ts && openapi-typescript specs/openapi.yaml --output src/definitions/openapi.ts",
     "initialise": "node scripts/initialise.js",
     "env:multi:enable": "node scripts/multiTenancy.js enable",
     "env:multi:disable": "node scripts/multiTenancy.js disable",
@@ -43,11 +43,11 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "10.0.3",
-    "@budibase/backend-core": "2.3.18-alpha.2",
-    "@budibase/client": "2.3.18-alpha.2",
-    "@budibase/pro": "2.3.18-alpha.1",
-    "@budibase/string-templates": "2.3.18-alpha.2",
-    "@budibase/types": "2.3.18-alpha.2",
+    "@budibase/backend-core": "2.3.18-alpha.21",
+    "@budibase/client": "2.3.18-alpha.21",
+    "@budibase/pro": "2.3.18-alpha.20",
+    "@budibase/string-templates": "2.3.18-alpha.21",
+    "@budibase/types": "2.3.18-alpha.21",
     "@bull-board/api": "3.7.0",
     "@bull-board/koa": "3.9.4",
     "@elastic/elasticsearch": "7.10.0",
@@ -87,6 +87,7 @@
     "koa-send": "5.0.0",
     "koa-session": "5.12.0",
     "koa-static": "5.0.0",
+    "koa-useragent": "^4.1.0",
     "koa2-ratelimit": "1.1.1",
     "lodash": "4.17.21",
     "memorystream": "0.3.1",
@@ -173,5 +174,5 @@
   "optionalDependencies": {
     "oracledb": "5.3.0"
   },
-  "gitHead": "4321a07944ae4653d6ea716bf4c2ba588f443660"
+  "gitHead": "2dfb0df2890303846ae7e6835b7d570aad57f775"
 }

package/scripts/test.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+if [[ -n $CI ]]
+then
+  # --runInBand performs better in ci where resources are limited
+  echo "jest --coverage --runInBand"
+  jest --coverage --runInBand
+else
+  # --maxWorkers performs better in development
+  echo "jest --coverage --maxWorkers=2"
+  jest --coverage --maxWorkers=2
+fi

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

@@ -1,9 +1,9 @@
+import { join } from "path"
+import { writeFileSync } from "fs"
+import { examples, schemas } from "./resources"
+import * as parameters from "./parameters"
+import * as security from "./security"
 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 = {}
 
@@ -60,7 +60,7 @@ const options = {
   apis: [join(__dirname, "..", "src", "api", "routes", "public", "*.ts")],
 }
 
-function writeFile(output, filename) {
+function writeFile(output: any, filename: string) {
   try {
     const path = join(__dirname, filename)
     let spec = output
@@ -79,7 +79,7 @@ function writeFile(output, filename) {
   }
 }
 
-function run() {
+export function run() {
   const outputJSON = swaggerJsdoc(options)
   options.format = ".yaml"
   const outputYAML = swaggerJsdoc(options)
@@ -90,5 +90,3 @@ function run() {
 if (require.main === module) {
   run()
 }
-
-module.exports = run

package/specs/openapi.json

@@ -1829,7 +1829,7 @@
   "paths": {
     "/applications": {
       "post": {
-        "operationId": "create",
+        "operationId": "appCreate",
         "summary": "Create an application",
         "tags": [
           "applications"
@@ -1870,7 +1870,7 @@
     },
     "/applications/{appId}": {
       "put": {
-        "operationId": "update",
+        "operationId": "appUpdate",
         "summary": "Update an application",
         "tags": [
           "applications"
@@ -1909,7 +1909,7 @@
         }
       },
       "delete": {
-        "operationId": "destroy",
+        "operationId": "appDestroy",
         "summary": "Delete an application",
         "tags": [
           "applications"
@@ -1938,7 +1938,7 @@
         }
       },
       "get": {
-        "operationId": "getById",
+        "operationId": "appGetById",
         "summary": "Retrieve an application",
         "tags": [
           "applications"
@@ -1969,7 +1969,7 @@
     },
     "/applications/{appId}/unpublish": {
       "post": {
-        "operationId": "unpublish",
+        "operationId": "appUnpublish",
         "summary": "Unpublish an application",
         "tags": [
           "applications"
@@ -1988,7 +1988,7 @@
     },
     "/applications/{appId}/publish": {
       "post": {
-        "operationId": "publish",
+        "operationId": "appPublish",
         "summary": "Unpublish an application",
         "tags": [
           "applications"
@@ -2019,7 +2019,7 @@
     },
     "/applications/search": {
       "post": {
-        "operationId": "search",
+        "operationId": "appSearch",
         "summary": "Search for applications",
         "description": "Based on application properties (currently only name) search for applications.",
         "tags": [
@@ -2056,7 +2056,7 @@
     },
     "/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": [
@@ -2104,7 +2104,7 @@
     },
     "/queries/search": {
       "post": {
-        "operationId": "search",
+        "operationId": "querySearch",
         "summary": "Search for queries",
         "description": "Based on query properties (currently only name) search for queries.",
         "tags": [
@@ -2146,7 +2146,7 @@
     },
     "/tables/{tableId}/rows": {
       "post": {
-        "operationId": "create",
+        "operationId": "rowCreate",
         "summary": "Create a row",
         "description": "Creates a row within the specified table.",
         "tags": [
@@ -2196,7 +2196,7 @@
     },
     "/tables/{tableId}/rows/{rowId}": {
       "put": {
-        "operationId": "update",
+        "operationId": "rowUpdate",
         "summary": "Update a row",
         "description": "Updates a row within the specified table.",
         "tags": [
@@ -2247,7 +2247,7 @@
         }
       },
       "delete": {
-        "operationId": "destroy",
+        "operationId": "rowDestroy",
         "summary": "Delete a row",
         "description": "Deletes a row within the specified table.",
         "tags": [
@@ -2283,7 +2283,7 @@
         }
       },
       "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.",
         "tags": [
@@ -2321,7 +2321,7 @@
     },
     "/tables/{tableId}/rows/search": {
       "post": {
-        "operationId": "search",
+        "operationId": "rowSearch",
         "summary": "Search for rows",
         "tags": [
           "rows"
@@ -2365,7 +2365,7 @@
     },
     "/tables": {
       "post": {
-        "operationId": "create",
+        "operationId": "tableCreate",
         "summary": "Create a table",
         "description": "Create a table, this could be internal or external.",
         "tags": [
@@ -2411,7 +2411,7 @@
     },
     "/tables/{tableId}": {
       "put": {
-        "operationId": "update",
+        "operationId": "tableUpdate",
         "summary": "Update a table",
         "description": "Update a table, this could be internal or external.",
         "tags": [
@@ -2458,7 +2458,7 @@
         }
       },
       "delete": {
-        "operationId": "destroy",
+        "operationId": "tableDestroy",
         "summary": "Delete a table",
         "description": "Delete a table, this could be internal or external.",
         "tags": [
@@ -2491,7 +2491,7 @@
         }
       },
       "get": {
-        "operationId": "getById",
+        "operationId": "tableGetById",
         "summary": "Retrieve a table",
         "description": "Lookup a table, this could be internal or external.",
         "tags": [
@@ -2526,7 +2526,7 @@
     },
     "/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.",
         "tags": [
@@ -2568,7 +2568,7 @@
     },
     "/users": {
       "post": {
-        "operationId": "create",
+        "operationId": "userCreate",
         "summary": "Create a user",
         "tags": [
           "users"
@@ -2604,7 +2604,7 @@
     },
     "/users/{userId}": {
       "put": {
-        "operationId": "update",
+        "operationId": "userUpdate",
         "summary": "Update a user",
         "tags": [
           "users"
@@ -2643,7 +2643,7 @@
         }
       },
       "delete": {
-        "operationId": "destroy",
+        "operationId": "userDestroy",
         "summary": "Delete a user",
         "tags": [
           "users"
@@ -2672,7 +2672,7 @@
         }
       },
       "get": {
-        "operationId": "getById",
+        "operationId": "userGetById",
         "summary": "Retrieve a user",
         "tags": [
           "users"
@@ -2703,7 +2703,7 @@
     },
     "/users/search": {
       "post": {
-        "operationId": "search",
+        "operationId": "userSearch",
         "summary": "Search for users",
         "description": "Based on user properties (currently only name) search for users.",
         "tags": [

package/specs/openapi.yaml

@@ -1397,7 +1397,7 @@ security:
 paths:
   /applications:
     post:
-      operationId: create
+      operationId: appCreate
       summary: Create an application
       tags:
         - applications
@@ -1421,7 +1421,7 @@ paths:
                   $ref: "#/components/examples/application"
   "/applications/{appId}":
     put:
-      operationId: update
+      operationId: appUpdate
       summary: Update an application
       tags:
         - applications
@@ -1444,7 +1444,7 @@ paths:
                 application:
                   $ref: "#/components/examples/application"
     delete:
-      operationId: destroy
+      operationId: appDestroy
       summary: Delete an application
       tags:
         - applications
@@ -1461,7 +1461,7 @@ paths:
                 application:
                   $ref: "#/components/examples/application"
     get:
-      operationId: getById
+      operationId: appGetById
       summary: Retrieve an application
       tags:
         - applications
@@ -1479,7 +1479,7 @@ paths:
                   $ref: "#/components/examples/application"
   "/applications/{appId}/unpublish":
     post:
-      operationId: unpublish
+      operationId: appUnpublish
       summary: Unpublish an application
       tags:
         - applications
@@ -1490,7 +1490,7 @@ paths:
           description: The app was published successfully.
   "/applications/{appId}/publish":
     post:
-      operationId: publish
+      operationId: appPublish
       summary: Unpublish an application
       tags:
         - applications
@@ -1508,7 +1508,7 @@ paths:
                   $ref: "#/components/examples/deploymentOutput"
   /applications/search:
     post:
-      operationId: search
+      operationId: appSearch
       summary: Search for applications
       description: Based on application properties (currently only name) search for
         applications.
@@ -1533,7 +1533,7 @@ paths:
                   $ref: "#/components/examples/applications"
   "/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,
@@ -1562,7 +1562,7 @@ paths:
                   $ref: "#/components/examples/sqlResponse"
   /queries/search:
     post:
-      operationId: search
+      operationId: querySearch
       summary: Search for queries
       description: Based on query properties (currently only name) search for queries.
       tags:
@@ -1587,7 +1587,7 @@ paths:
                   $ref: "#/components/examples/queries"
   "/tables/{tableId}/rows":
     post:
-      operationId: create
+      operationId: rowCreate
       summary: Create a row
       description: Creates a row within the specified table.
       tags:
@@ -1618,7 +1618,7 @@ paths:
                   $ref: "#/components/examples/row"
   "/tables/{tableId}/rows/{rowId}":
     put:
-      operationId: update
+      operationId: rowUpdate
       summary: Update a row
       description: Updates a row within the specified table.
       tags:
@@ -1648,7 +1648,7 @@ paths:
                 row:
                   $ref: "#/components/examples/row"
     delete:
-      operationId: destroy
+      operationId: rowDestroy
       summary: Delete a row
       description: Deletes a row within the specified table.
       tags:
@@ -1669,7 +1669,7 @@ paths:
                 row:
                   $ref: "#/components/examples/row"
     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
@@ -1692,7 +1692,7 @@ paths:
                   $ref: "#/components/examples/enrichedRow"
   "/tables/{tableId}/rows/search":
     post:
-      operationId: search
+      operationId: rowSearch
       summary: Search for rows
       tags:
         - rows
@@ -1718,7 +1718,7 @@ paths:
                   $ref: "#/components/examples/rows"
   /tables:
     post:
-      operationId: create
+      operationId: tableCreate
       summary: Create a table
       description: Create a table, this could be internal or external.
       tags:
@@ -1746,7 +1746,7 @@ paths:
                   $ref: "#/components/examples/table"
   "/tables/{tableId}":
     put:
-      operationId: update
+      operationId: tableUpdate
       summary: Update a table
       description: Update a table, this could be internal or external.
       tags:
@@ -1773,7 +1773,7 @@ paths:
                 table:
                   $ref: "#/components/examples/table"
     delete:
-      operationId: destroy
+      operationId: tableDestroy
       summary: Delete a table
       description: Delete a table, this could be internal or external.
       tags:
@@ -1792,7 +1792,7 @@ paths:
                 table:
                   $ref: "#/components/examples/table"
     get:
-      operationId: getById
+      operationId: tableGetById
       summary: Retrieve a table
       description: Lookup a table, this could be internal or external.
       tags:
@@ -1812,7 +1812,7 @@ paths:
                   $ref: "#/components/examples/table"
   /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.
@@ -1838,7 +1838,7 @@ paths:
                   $ref: "#/components/examples/tables"
   /users:
     post:
-      operationId: create
+      operationId: userCreate
       summary: Create a user
       tags:
         - users
@@ -1860,7 +1860,7 @@ paths:
                   $ref: "#/components/examples/user"
   "/users/{userId}":
     put:
-      operationId: update
+      operationId: userUpdate
       summary: Update a user
       tags:
         - users
@@ -1883,7 +1883,7 @@ paths:
                 user:
                   $ref: "#/components/examples/user"
     delete:
-      operationId: destroy
+      operationId: userDestroy
       summary: Delete a user
       tags:
         - users
@@ -1900,7 +1900,7 @@ paths:
                 user:
                   $ref: "#/components/examples/user"
     get:
-      operationId: getById
+      operationId: userGetById
       summary: Retrieve a user
       tags:
         - users
@@ -1918,7 +1918,7 @@ paths:
                   $ref: "#/components/examples/user"
   /users/search:
     post:
-      operationId: search
+      operationId: userSearch
       summary: Search for users
       description: Based on user properties (currently only name) search for users.
       tags:

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

@@ -1,4 +1,4 @@
-exports.tableId = {
+export const tableId = {
   in: "path",
   name: "tableId",
   required: true,
@@ -8,7 +8,7 @@ exports.tableId = {
   },
 }
 
-exports.rowId = {
+export const rowId = {
   in: "path",
   name: "rowId",
   required: true,
@@ -18,7 +18,7 @@ exports.rowId = {
   },
 }
 
-exports.appId = {
+export const appId = {
   in: "header",
   name: "x-budibase-app-id",
   required: true,
@@ -28,7 +28,7 @@ exports.appId = {
   },
 }
 
-exports.appIdUrl = {
+export const appIdUrl = {
   in: "path",
   name: "appId",
   required: true,
@@ -38,7 +38,7 @@ exports.appIdUrl = {
   },
 }
 
-exports.queryId = {
+export const queryId = {
   in: "path",
   name: "queryId",
   required: true,
@@ -48,7 +48,7 @@ exports.queryId = {
   },
 }
 
-exports.userId = {
+export const userId = {
   in: "path",
   name: "userId",
   required: true,

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

@@ -1,6 +1,6 @@
-const userResource = require("./user")
-const { object } = require("./utils")
-const Resource = require("./utils/Resource")
+import userResource from "./user"
+import { object } from "./utils"
+import Resource from "./utils/Resource"
 
 const application = {
   _id: "app_metadata",
@@ -96,7 +96,7 @@ const deploymentOutputSchema = object({
   },
 })
 
-module.exports = new Resource()
+export default new Resource()
   .setExamples({
     application: {
       value: {

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

@@ -1,11 +1,11 @@
-const application = require("./application")
-const row = require("./row")
-const table = require("./table")
-const query = require("./query")
-const user = require("./user")
-const misc = require("./misc")
+import application from "./application"
+import row from "./row"
+import table from "./table"
+import query from "./query"
+import user from "./user"
+import misc from "./misc"
 
-exports.examples = {
+export const examples = {
   ...application.getExamples(),
   ...row.getExamples(),
   ...table.getExamples(),
@@ -14,7 +14,7 @@ exports.examples = {
   ...misc.getExamples(),
 }
 
-exports.schemas = {
+export const schemas = {
   ...application.getSchemas(),
   ...row.getSchemas(),
   ...table.getSchemas(),

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

@@ -1,7 +1,7 @@
-const { object } = require("./utils")
-const Resource = require("./utils/Resource")
+import { object } from "./utils"
+import Resource from "./utils/Resource"
 
-module.exports = new Resource().setSchemas({
+export default new Resource().setSchemas({
   rowSearch: object(
     {
       query: {

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

@@ -1,6 +1,6 @@
-const Resource = require("./utils/Resource")
-const { object } = require("./utils")
-const { BaseQueryVerbs } = require("../../src/constants")
+import Resource from "./utils/Resource"
+import { object } from "./utils"
+import { BaseQueryVerbs } from "../../src/constants"
 
 const query = {
   _id: "query_datasource_plus_4d8be0c506b9465daf4bf84d890fdab6_454854487c574d45bc4029b1e153219e",
@@ -189,7 +189,7 @@ const executeQueryOutputSchema = object(
   { required: ["data"] }
 )
 
-module.exports = new Resource()
+export default new Resource()
   .setExamples({
     query: {
       value: {