@budibase/server 1.0.81 → 1.0.84-alpha.0

package/dist/utilities/index.js

@@ -142,3 +142,10 @@ exports.formatBytes = bytes => {
     }
     return `${size.toFixed(size < 10 && unit > 0 ? 1 : 0)}${units[unit]}`;
 };
+exports.convertBookmark = bookmark => {
+    const IS_NUMBER = /^\d+\.?\d*$/;
+    if (typeof bookmark === "string" && bookmark.match(IS_NUMBER)) {
+        return parseFloat(bookmark);
+    }
+    return bookmark;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "1.0.81",
+  "version": "1.0.84-alpha.0",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -71,9 +71,9 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.0.3",
-    "@budibase/backend-core": "^1.0.81",
-    "@budibase/client": "^1.0.81",
-    "@budibase/string-templates": "^1.0.81",
+    "@budibase/backend-core": "^1.0.84-alpha.0",
+    "@budibase/client": "^1.0.84-alpha.0",
+    "@budibase/string-templates": "^1.0.84-alpha.0",
     "@bull-board/api": "^3.7.0",
     "@bull-board/koa": "^3.7.0",
     "@elastic/elasticsearch": "7.10.0",
@@ -175,5 +175,5 @@
   "optionalDependencies": {
     "oracledb": "^5.3.0"
   },
-  "gitHead": "60fae11087000f6e76be33e7b469776d323a871d"
+  "gitHead": "5749e88ed2cf6f9a29c10461163ea65ba03553ef"
 }

package/scripts/docs/toSwagger.js

@@ -51,7 +51,7 @@ function extractPaths(apidocJson) {
     // Surrounds URL parameters with curly brackets -> :email with {email}
     let pathKeys = []
     for (let j = 1; j < matches.length; j++) {
-      let key = matches[j].substr(1)
+      let key = matches[j].slice(1)
       url = url.replace(matches[j], "{" + key + "}")
       pathKeys.push(key)
     }

package/specs/openapi.json

@@ -437,8 +437,7 @@
           }
         },
         "required": [
-          "name",
-          "url"
+          "name"
         ]
       },
       "applicationOutput": {
@@ -503,6 +502,71 @@
           "data"
         ]
       },
+      "applicationSearch": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The name of the app.",
+                  "type": "string"
+                },
+                "url": {
+                  "description": "The URL by which the app is accessed, this must be URL encoded.",
+                  "type": "string"
+                },
+                "_id": {
+                  "description": "The ID of the app.",
+                  "type": "string"
+                },
+                "status": {
+                  "description": "The status of the app, stating it if is the development or published version.",
+                  "type": "string",
+                  "enum": [
+                    "development",
+                    "published"
+                  ]
+                },
+                "createdAt": {
+                  "description": "States when the app was created, will be constant. Stored in ISO format.",
+                  "type": "string"
+                },
+                "updatedAt": {
+                  "description": "States the last time the app was updated - stored in ISO format.",
+                  "type": "string"
+                },
+                "version": {
+                  "description": "States the version of the Budibase client this app is currently based on.",
+                  "type": "string"
+                },
+                "tenantId": {
+                  "description": "In a multi-tenant environment this will state the tenant this app is within.",
+                  "type": "string"
+                },
+                "lockedBy": {
+                  "description": "The user this app is currently being built by.",
+                  "type": "object"
+                }
+              },
+              "required": [
+                "_id",
+                "name",
+                "url",
+                "status",
+                "createdAt",
+                "updatedAt",
+                "version"
+              ]
+            }
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
       "row": {
         "description": "The row to be created/updated, based on the table schema.",
         "type": "object",
@@ -980,6 +1044,221 @@
           "data"
         ]
       },
+      "tableSearch": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "description": "The table to be created/updated.",
+              "type": "object",
+              "required": [
+                "name",
+                "schema",
+                "_id"
+              ],
+              "properties": {
+                "name": {
+                  "description": "The name of the table.",
+                  "type": "string"
+                },
+                "primaryDisplay": {
+                  "type": "string",
+                  "description": "The name of the column which should be used in relationship tags when relating to this table."
+                },
+                "schema": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "oneOf": [
+                      {
+                        "type": "object",
+                        "properties": {
+                          "type": {
+                            "type": "string",
+                            "enum": [
+                              "link"
+                            ],
+                            "description": "A relationship column."
+                          },
+                          "constraints": {
+                            "type": "object",
+                            "description": "A constraint can be applied to the column which will be validated against when a row is saved.",
+                            "properties": {
+                              "type": {
+                                "type": "string",
+                                "enum": [
+                                  "string",
+                                  "number",
+                                  "object",
+                                  "boolean"
+                                ]
+                              },
+                              "presence": {
+                                "type": "boolean",
+                                "description": "Defines whether the column is required or not."
+                              }
+                            }
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "The name of the column."
+                          },
+                          "autocolumn": {
+                            "type": "boolean",
+                            "description": "Defines whether the column is automatically generated."
+                          },
+                          "fieldName": {
+                            "type": "string",
+                            "description": "The name of the column which a relationship column is related to in another table."
+                          },
+                          "tableId": {
+                            "type": "string",
+                            "description": "The ID of the table which a relationship column is related to."
+                          },
+                          "relationshipType": {
+                            "type": "string",
+                            "enum": [
+                              "one-to-many",
+                              "many-to-one",
+                              "many-to-many"
+                            ],
+                            "description": "Defines the type of relationship that this column will be used for."
+                          },
+                          "through": {
+                            "type": "string",
+                            "description": "When using a SQL table that contains many to many relationships this defines the table the relationships are linked through."
+                          },
+                          "foreignKey": {
+                            "type": "string",
+                            "description": "When using a SQL table that contains a one to many relationship this defines the foreign key."
+                          },
+                          "throughFrom": {
+                            "type": "string",
+                            "description": "When using a SQL table that utilises a through table, this defines the primary key in the through table for this table."
+                          },
+                          "throughTo": {
+                            "type": "string",
+                            "description": "When using a SQL table that utilises a through table, this defines the primary key in the through table for the related table."
+                          }
+                        }
+                      },
+                      {
+                        "type": "object",
+                        "properties": {
+                          "type": {
+                            "type": "string",
+                            "enum": [
+                              "formula"
+                            ],
+                            "description": "A formula column."
+                          },
+                          "constraints": {
+                            "type": "object",
+                            "description": "A constraint can be applied to the column which will be validated against when a row is saved.",
+                            "properties": {
+                              "type": {
+                                "type": "string",
+                                "enum": [
+                                  "string",
+                                  "number",
+                                  "object",
+                                  "boolean"
+                                ]
+                              },
+                              "presence": {
+                                "type": "boolean",
+                                "description": "Defines whether the column is required or not."
+                              }
+                            }
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "The name of the column."
+                          },
+                          "autocolumn": {
+                            "type": "boolean",
+                            "description": "Defines whether the column is automatically generated."
+                          },
+                          "formula": {
+                            "type": "string",
+                            "description": "Defines a Handlebars or JavaScript formula to use, note that Javascript formulas are expected to be provided in the base64 format."
+                          },
+                          "formulaType": {
+                            "type": "string",
+                            "enum": [
+                              "static",
+                              "dynamic"
+                            ],
+                            "description": "Defines whether this is a static or dynamic formula."
+                          }
+                        }
+                      },
+                      {
+                        "type": "object",
+                        "properties": {
+                          "type": {
+                            "type": "string",
+                            "enum": [
+                              "string",
+                              "longform",
+                              "options",
+                              "number",
+                              "boolean",
+                              "array",
+                              "datetime",
+                              "attachment",
+                              "link",
+                              "formula",
+                              "auto",
+                              "json",
+                              "internal"
+                            ],
+                            "description": "Defines the type of the column, most explain themselves, a link column is a relationship."
+                          },
+                          "constraints": {
+                            "type": "object",
+                            "description": "A constraint can be applied to the column which will be validated against when a row is saved.",
+                            "properties": {
+                              "type": {
+                                "type": "string",
+                                "enum": [
+                                  "string",
+                                  "number",
+                                  "object",
+                                  "boolean"
+                                ]
+                              },
+                              "presence": {
+                                "type": "boolean",
+                                "description": "Defines whether the column is required or not."
+                              }
+                            }
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "The name of the column."
+                          },
+                          "autocolumn": {
+                            "type": "boolean",
+                            "description": "Defines whether the column is automatically generated."
+                          }
+                        }
+                      }
+                    ]
+                  }
+                },
+                "_id": {
+                  "description": "The ID of the table.",
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
       "executeQuery": {
         "description": "The query body must contain the required parameters for the query, this depends on query type, setup and bindings.",
         "type": "object",
@@ -1074,6 +1353,71 @@
           "_id"
         ]
       },
+      "querySearch": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "_id": {
+                  "description": "The ID of the query.",
+                  "type": "string"
+                },
+                "datasourceId": {
+                  "description": "The ID of the data source the query belongs to.",
+                  "type": "string"
+                },
+                "parameters": {
+                  "description": "The bindings which are required to perform this query.",
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "fields": {
+                  "description": "The fields that are used to perform this query, e.g. the sql statement",
+                  "type": "object"
+                },
+                "queryVerb": {
+                  "description": "The verb that describes this query.",
+                  "enum": [
+                    "create",
+                    "read",
+                    "update",
+                    "delete"
+                  ]
+                },
+                "name": {
+                  "description": "The name of the query.",
+                  "type": "string"
+                },
+                "schema": {
+                  "description": "The schema of the data returned when the query is executed.",
+                  "type": "object"
+                },
+                "transformer": {
+                  "description": "The JavaScript transformer function, applied after the query responds with data.",
+                  "type": "string"
+                },
+                "readable": {
+                  "description": "Whether the query has readable data.",
+                  "type": "boolean"
+                }
+              },
+              "required": [
+                "name",
+                "schema",
+                "_id"
+              ]
+            }
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
       "user": {
         "type": "object",
         "properties": {
@@ -1215,6 +1559,86 @@
           "data"
         ]
       },
+      "userSearch": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "email": {
+                  "description": "The email address of the user, this must be unique.",
+                  "type": "string"
+                },
+                "password": {
+                  "description": "The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure.",
+                  "type": "string"
+                },
+                "status": {
+                  "description": "The status of the user, if they are active.",
+                  "type": "string",
+                  "enum": [
+                    "active"
+                  ]
+                },
+                "firstName": {
+                  "description": "The first name of the user",
+                  "type": "string"
+                },
+                "lastName": {
+                  "description": "The last name of the user",
+                  "type": "string"
+                },
+                "forceResetPassword": {
+                  "description": "If set to true forces the user to reset their password on first login.",
+                  "type": "boolean"
+                },
+                "builder": {
+                  "description": "Describes if the user is a builder user or not.",
+                  "type": "object",
+                  "properties": {
+                    "global": {
+                      "description": "If set to true the user will be able to build any app in the system.",
+                      "type": "boolean"
+                    }
+                  }
+                },
+                "admin": {
+                  "description": "Describes if the user is an admin user or not.",
+                  "type": "object",
+                  "properties": {
+                    "global": {
+                      "description": "If set to true the user will be able to administrate the system.",
+                      "type": "boolean"
+                    }
+                  }
+                },
+                "roles": {
+                  "description": "Contains the roles of the user per app (assuming they are not a builder user).",
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "description": "A map of app ID (production app ID, minus the _dev component) to a role ID, e.g. ADMIN."
+                  }
+                },
+                "_id": {
+                  "description": "The ID of the user.",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "email",
+                "roles",
+                "_id"
+              ]
+            }
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
       "nameSearch": {
         "type": "object",
         "properties": {
@@ -1378,11 +1802,6 @@
         "tags": [
           "applications"
         ],
-        "parameters": [
-          {
-            "$ref": "#/components/parameters/appId"
-          }
-        ],
         "requestBody": {
           "required": true,
           "content": {
@@ -1399,18 +1818,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "required": [
-                    "data"
-                  ],
-                  "properties": {
-                    "data": {
-                      "type": "array",
-                      "items": {
-                        "$ref": "#/components/schemas/application"
-                      }
-                    }
-                  }
+                  "$ref": "#/components/schemas/applicationSearch"
                 },
                 "examples": {
                   "applications": {
@@ -1498,18 +1906,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "required": [
-                    "data"
-                  ],
-                  "properties": {
-                    "data": {
-                      "type": "array",
-                      "items": {
-                        "$ref": "#/components/schemas/query"
-                      }
-                    }
-                  }
+                  "$ref": "#/components/schemas/querySearch"
                 },
                 "examples": {
                   "queries": {
@@ -2025,18 +2422,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "required": [
-                    "data"
-                  ],
-                  "properties": {
-                    "data": {
-                      "type": "array",
-                      "items": {
-                        "$ref": "#/components/schemas/table"
-                      }
-                    }
-                  }
+                  "$ref": "#/components/schemas/tableSearch"
                 },
                 "examples": {
                   "tables": {
@@ -2203,18 +2589,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "required": [
-                    "data"
-                  ],
-                  "properties": {
-                    "data": {
-                      "type": "array",
-                      "items": {
-                        "$ref": "#/components/schemas/user"
-                      }
-                    }
-                  }
+                  "$ref": "#/components/schemas/userSearch"
                 },
                 "examples": {
                   "users": {