@budibase/server 1.3.19-alpha.3 → 1.3.19-alpha.4

package/dist/utilities/workerRequests.js

@@ -128,3 +128,7 @@ exports.getChecklist = () => __awaiter(void 0, void 0, void 0, function* () {
     const response = yield fetch(checkSlashesInUrl(env.WORKER_URL + "/api/global/configs/checklist"), request(null, { method: "GET" }));
     return checkResponse(response, "get checklist");
 });
+exports.generateApiKey = (userId) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield fetch(checkSlashesInUrl(env.WORKER_URL + "/api/global/self/api_key"), request(null, { method: "POST", body: { userId } }));
+    return checkResponse(response, "generate API key");
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "1.3.19-alpha.3",
+  "version": "1.3.19-alpha.4",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -77,11 +77,11 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "10.0.3",
-    "@budibase/backend-core": "1.3.19-alpha.3",
-    "@budibase/client": "1.3.19-alpha.3",
-    "@budibase/pro": "1.3.19-alpha.2",
-    "@budibase/string-templates": "1.3.19-alpha.3",
-    "@budibase/types": "1.3.19-alpha.3",
+    "@budibase/backend-core": "1.3.19-alpha.4",
+    "@budibase/client": "1.3.19-alpha.4",
+    "@budibase/pro": "1.3.19-alpha.3",
+    "@budibase/string-templates": "1.3.19-alpha.4",
+    "@budibase/types": "1.3.19-alpha.4",
     "@bull-board/api": "3.7.0",
     "@bull-board/koa": "3.9.4",
     "@elastic/elasticsearch": "7.10.0",
@@ -199,5 +199,5 @@
   "optionalDependencies": {
     "oracledb": "5.3.0"
   },
-  "gitHead": "70ca5eab5924a14ae6558924706bfa970269944a"
+  "gitHead": "298b2b17d1d07adf98c7e9d034ae92276b84b3ed"
 }

package/specs/openapi.json

@@ -1659,6 +1659,117 @@
           "data"
         ]
       },
+      "rowSearch": {
+        "type": "object",
+        "properties": {
+          "query": {
+            "type": "object",
+            "properties": {
+              "allOr": {
+                "type": "boolean",
+                "description": "Specifies that a row should be returned if it satisfies any of the specified options, rather than requiring it to fulfill all the search parameters. This defaults to false, meaning AND logic will be used."
+              },
+              "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 in the format of an object with a \"low\" and \"high\" property.",
+                "example": {
+                  "columnName1": {
+                    "low": 10,
+                    "high": 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."
+              }
+            }
+          }
+        },
+        "required": [
+          "query"
+        ]
+      },
       "nameSearch": {
         "type": "object",
         "properties": {
@@ -2129,115 +2240,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "type": "object",
-                "required": [
-                  "query"
-                ],
-                "properties": {
-                  "query": {
-                    "type": "object",
-                    "properties": {
-                      "allOr": {
-                        "type": "boolean",
-                        "description": "Specifies that a row should be returned if it satisfies any of the specified options, rather than requiring it to fulfill all the search parameters. This defaults to false, meaning AND logic will be used."
-                      },
-                      "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 in the format of an object with a \"low\" and \"high\" property.",
-                        "example": {
-                          "columnName1": {
-                            "low": 10,
-                            "high": 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."
-                      }
-                    }
-                  }
-                }
+                "$ref": "#/components/schemas/rowSearch"
               }
             }
           }

package/specs/openapi.yaml

@@ -1264,6 +1264,98 @@ components:
               - _id
       required:
         - data
+    rowSearch:
+      type: object
+      properties:
+        query:
+          type: object
+          properties:
+            allOr:
+              type: boolean
+              description: Specifies that a row should be returned if it satisfies any of the
+                specified options, rather than requiring it to fulfill all the
+                search parameters. This defaults to false, meaning AND logic
+                will be used.
+            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 in the format
+                of an object with a "low" and "high" property.
+              example:
+                columnName1:
+                  low: 10
+                  high: 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.
+      required:
+        - query
     nameSearch:
       type: object
       properties:
@@ -1544,97 +1636,7 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              required:
-                - query
-              properties:
-                query:
-                  type: object
-                  properties:
-                    allOr:
-                      type: boolean
-                      description: Specifies that a row should be returned if it satisfies any of the
-                        specified options, rather than requiring it to fulfill
-                        all the search parameters. This defaults to false,
-                        meaning AND logic will be used.
-                    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 in the format
-                        of an object with a "low" and "high" property.
-                      example:
-                        columnName1:
-                          low: 10
-                          high: 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.
+              $ref: "#/components/schemas/rowSearch"
       responses:
         "200":
           description: The response will contain an array of rows that match the search

package/specs/resources/misc.js

@@ -2,6 +2,122 @@ const { object } = require("./utils")
 const Resource = require("./utils/Resource")
 
 module.exports = new Resource().setSchemas({
+  rowSearch: object(
+    {
+      query: {
+        type: "object",
+        properties: {
+          allOr: {
+            type: "boolean",
+            description:
+              "Specifies that a row should be returned if it satisfies any of the specified options, rather than requiring it to fulfill all the search parameters. This defaults to false, meaning AND logic will be used.",
+          },
+          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 in the format of an object with a "low" and "high" property.',
+            example: {
+              columnName1: {
+                low: 10,
+                high: 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.",
+          },
+        },
+      },
+    },
+    {
+      required: ["query"],
+    }
+  ),
   nameSearch: object({
     name: {
       type: "string",

package/src/api/controllers/public/mapping/types.ts

@@ -4,10 +4,18 @@ export type Query = components["schemas"]["query"]
 export type ExecuteQuery = components["schemas"]["executeQueryOutput"]
 
 export type Application = components["schemas"]["applicationOutput"]["data"]
+export type CreateApplicationParams = components["schemas"]["application"]
 
 export type Table = components["schemas"]["tableOutput"]["data"]
+export type CreateTableParams = components["schemas"]["table"]
 
 export type Row = components["schemas"]["rowOutput"]["data"]
 export type RowSearch = components["schemas"]["searchOutput"]
+export type CreateRowParams = components["schemas"]["row"]
 
 export type User = components["schemas"]["userOutput"]["data"]
+export type CreateUserParams = components["schemas"]["user"]
+
+export type SearchInputParams =
+  | components["schemas"]["nameSearch"]
+  | components["schemas"]["rowSearch"]