@budibase/server 0.0.32 → 0.0.999-alpha.30

package/specs/parameters.ts

@@ -0,0 +1,59 @@
+export const tableId = {
+  in: "path",
+  name: "tableId",
+  required: true,
+  description: "The ID of the table which this request is targeting.",
+  schema: {
+    type: "string",
+  },
+}
+
+export const rowId = {
+  in: "path",
+  name: "rowId",
+  required: true,
+  description: "The ID of the row which this request is targeting.",
+  schema: {
+    type: "string",
+  },
+}
+
+export const appId = {
+  in: "header",
+  name: "x-budibase-app-id",
+  required: true,
+  description: "The ID of the app which this request is targeting.",
+  schema: {
+    type: "string",
+  },
+}
+
+export const appIdUrl = {
+  in: "path",
+  name: "appId",
+  required: true,
+  description: "The ID of the app which this request is targeting.",
+  schema: {
+    type: "string",
+  },
+}
+
+export const queryId = {
+  in: "path",
+  name: "queryId",
+  required: true,
+  description: "The ID of the query which this request is targeting.",
+  schema: {
+    type: "string",
+  },
+}
+
+export const userId = {
+  in: "path",
+  name: "userId",
+  required: true,
+  description: "The ID of the user which this request is targeting.",
+  schema: {
+    type: "string",
+  },
+}

package/specs/resources/application.ts

@@ -0,0 +1,137 @@
+import userResource from "./user"
+import { object } from "./utils"
+import Resource from "./utils/Resource"
+
+const application = {
+  _id: "app_metadata",
+  appId: "app_dev_957b12f943d348faa61db7e18e088d0f",
+  version: "1.0.58-alpha.0",
+  name: "App name",
+  url: "/app-url",
+  tenantId: "default",
+  updatedAt: "2022-02-22T13:00:54.035Z",
+  createdAt: "2022-02-11T18:02:26.961Z",
+  status: "development",
+  lockedBy: userResource.getExamples().user.value.user,
+}
+
+const deployment = {
+  _id: "ef12381f934b4f129675cdbb76eff3c2",
+  status: "SUCCESS",
+  appUrl: "/app-url",
+}
+
+const base = {
+  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",
+  },
+}
+
+const applicationSchema = object(base, { required: ["name"] })
+
+const applicationOutputSchema = object(
+  {
+    ...base,
+    _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",
+    ],
+  }
+)
+
+const deploymentOutputSchema = object({
+  _id: {
+    description: "The ID of the app.",
+    type: "string",
+  },
+  status: {
+    description: "Status of the deployment, whether it succeeded or failed",
+    type: "string",
+    enum: ["SUCCESS", "FAILURE"],
+  },
+  appUrl: {
+    description: "The URL of the published app",
+    type: "string",
+  },
+})
+
+export default new Resource()
+  .setExamples({
+    application: {
+      value: {
+        data: application,
+      },
+    },
+    applications: {
+      value: {
+        data: [application],
+      },
+    },
+    deploymentOutput: {
+      value: {
+        data: deployment,
+      },
+    },
+  })
+  .setSchemas({
+    application: applicationSchema,
+    applicationOutput: object({
+      data: applicationOutputSchema,
+    }),
+    applicationSearch: object({
+      data: {
+        type: "array",
+        items: applicationOutputSchema,
+      },
+    }),
+    deploymentOutput: object({
+      data: deploymentOutputSchema,
+    }),
+  })

package/specs/resources/index.ts

@@ -0,0 +1,26 @@
+import application from "./application"
+import row from "./row"
+import table from "./table"
+import query from "./query"
+import user from "./user"
+import metrics from "./metrics"
+import misc from "./misc"
+
+export const examples = {
+  ...application.getExamples(),
+  ...row.getExamples(),
+  ...table.getExamples(),
+  ...query.getExamples(),
+  ...user.getExamples(),
+  ...misc.getExamples(),
+  ...metrics.getExamples(),
+}
+
+export const schemas = {
+  ...application.getSchemas(),
+  ...row.getSchemas(),
+  ...table.getSchemas(),
+  ...query.getSchemas(),
+  ...user.getSchemas(),
+  ...misc.getSchemas(),
+}

package/specs/resources/metrics.ts

@@ -0,0 +1,81 @@
+import Resource from "./utils/Resource"
+
+const metricsResponse =
+  "# HELP budibase_os_uptime Time in seconds that the host operating system has been up.\n" +
+  "# TYPE budibase_os_uptime counter\n" +
+  "budibase_os_uptime 54958\n" +
+  "# HELP budibase_os_free_mem Bytes of memory free for usage on the host operating system.\n" +
+  "# TYPE budibase_os_free_mem gauge\n" +
+  "budibase_os_free_mem 804507648\n" +
+  "# HELP budibase_os_total_mem Total bytes of memory on the host operating system.\n" +
+  "# TYPE budibase_os_total_mem gauge\n" +
+  "budibase_os_total_mem 16742404096\n" +
+  "# HELP budibase_os_used_mem Total bytes of memory in use on the host operating system.\n" +
+  "# TYPE budibase_os_used_mem gauge\n" +
+  "budibase_os_used_mem 15937896448\n" +
+  "# HELP budibase_os_load1 Host operating system load average.\n" +
+  "# TYPE budibase_os_load1 gauge\n" +
+  "budibase_os_load1 1.91\n" +
+  "# HELP budibase_os_load5 Host operating system load average.\n" +
+  "# TYPE budibase_os_load5 gauge\n" +
+  "budibase_os_load5 1.75\n" +
+  "# HELP budibase_os_load15 Host operating system load average.\n" +
+  "# TYPE budibase_os_load15 gauge\n" +
+  "budibase_os_load15 1.56\n" +
+  "# HELP budibase_tenant_user_count The number of users created.\n" +
+  "# TYPE budibase_tenant_user_count gauge\n" +
+  "budibase_tenant_user_count 1\n" +
+  "# HELP budibase_tenant_app_count The number of apps created by a user.\n" +
+  "# TYPE budibase_tenant_app_count gauge\n" +
+  "budibase_tenant_app_count 2\n" +
+  "# HELP budibase_tenant_production_app_count The number of apps a user has published.\n" +
+  "# TYPE budibase_tenant_production_app_count gauge\n" +
+  "budibase_tenant_production_app_count 1\n" +
+  "# HELP budibase_tenant_dev_app_count The number of apps a user has unpublished in development.\n" +
+  "# TYPE budibase_tenant_dev_app_count gauge\n" +
+  "budibase_tenant_dev_app_count 1\n" +
+  "# HELP budibase_tenant_db_count The number of couchdb databases including global tables such as _users.\n" +
+  "# TYPE budibase_tenant_db_count gauge\n" +
+  "budibase_tenant_db_count 3\n" +
+  "# HELP budibase_quota_usage_apps The number of apps created.\n" +
+  "# TYPE budibase_quota_usage_apps gauge\n" +
+  "budibase_quota_usage_apps 1\n" +
+  "# HELP budibase_quota_limit_apps The limit on the number of apps that can be created.\n" +
+  "# TYPE budibase_quota_limit_apps gauge\n" +
+  "budibase_quota_limit_apps 9007199254740991\n" +
+  "# HELP budibase_quota_usage_rows The number of database rows used from the quota.\n" +
+  "# TYPE budibase_quota_usage_rows gauge\n" +
+  "budibase_quota_usage_rows 0\n" +
+  "# HELP budibase_quota_limit_rows The limit on the number of rows that can be created.\n" +
+  "# TYPE budibase_quota_limit_rows gauge\n" +
+  "budibase_quota_limit_rows 9007199254740991\n" +
+  "# HELP budibase_quota_usage_plugins The number of plugins in use.\n" +
+  "# TYPE budibase_quota_usage_plugins gauge\n" +
+  "budibase_quota_usage_plugins 0\n" +
+  "# HELP budibase_quota_limit_plugins The limit on the number of plugins that can be created.\n" +
+  "# TYPE budibase_quota_limit_plugins gauge\n" +
+  "budibase_quota_limit_plugins 9007199254740991\n" +
+  "# HELP budibase_quota_usage_user_groups The number of user groups created.\n" +
+  "# TYPE budibase_quota_usage_user_groups gauge\n" +
+  "budibase_quota_usage_user_groups 0\n" +
+  "# HELP budibase_quota_limit_user_groups The limit on the number of user groups that can be created.\n" +
+  "# TYPE budibase_quota_limit_user_groups gauge\n" +
+  "budibase_quota_limit_user_groups 9007199254740991\n" +
+  "# HELP budibase_quota_usage_queries The number of queries used in the current month.\n" +
+  "# TYPE budibase_quota_usage_queries gauge\n" +
+  "budibase_quota_usage_queries 0\n" +
+  "# HELP budibase_quota_limit_queries The limit on the number of queries for the current month.\n" +
+  "# TYPE budibase_quota_limit_queries gauge\n" +
+  "budibase_quota_limit_queries 9007199254740991\n" +
+  "# HELP budibase_quota_usage_automations The number of automations used in the current month.\n" +
+  "# TYPE budibase_quota_usage_automations gauge\n" +
+  "budibase_quota_usage_automations 0\n" +
+  "# HELP budibase_quota_limit_automations The limit on the number of automations that can be created.\n" +
+  "# TYPE budibase_quota_limit_automations gauge\n" +
+  "budibase_quota_limit_automations 9007199254740991\n"
+
+export default new Resource().setExamples({
+  metrics: {
+    value: metricsResponse,
+  },
+})

package/specs/resources/misc.ts

@@ -0,0 +1,128 @@
+import { object } from "./utils"
+import Resource from "./utils/Resource"
+
+export default 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",
+      description:
+        "The name to be used when searching - this will be used in a case insensitive starts with match.",
+    },
+  }),
+})

package/specs/resources/query.ts

@@ -0,0 +1,217 @@
+import Resource from "./utils/Resource"
+import { object } from "./utils"
+import { BaseQueryVerbs } from "../../src/constants"
+
+const query = {
+  _id: "query_datasource_plus_4d8be0c506b9465daf4bf84d890fdab6_454854487c574d45bc4029b1e153219e",
+  datasourceId: "datasource_plus_4d8be0c506b9465daf4bf84d890fdab6",
+  parameters: [],
+  fields: {
+    sql: "select * from persons",
+  },
+  queryVerb: "read",
+  name: "Help",
+  schema: {
+    personid: {
+      name: "personid",
+      type: "string",
+    },
+    lastname: {
+      name: "lastname",
+      type: "string",
+    },
+    firstname: {
+      name: "firstname",
+      type: "string",
+    },
+    address: {
+      name: "address",
+      type: "string",
+    },
+    city: {
+      name: "city",
+      type: "string",
+    },
+  },
+  transformer: "return data",
+  readable: true,
+}
+
+const restResponse = {
+  value: {
+    data: [
+      {
+        value: "<html lang='en-GB'></html>",
+      },
+    ],
+    pagination: {
+      cursor: "2",
+    },
+    raw: "<html lang='en-GB'></html>",
+    headers: {
+      "content-type": "text/html; charset=ISO-8859-1",
+    },
+  },
+}
+
+const sqlResponse = {
+  value: {
+    data: [
+      {
+        personid: 1,
+        lastname: "Hughes",
+        firstname: "Mike",
+        address: "123 Fake Street",
+        city: "Belfast",
+      },
+      {
+        personid: 2,
+        lastname: "Smith",
+        firstname: "John",
+        address: "64 Updown Road",
+        city: "Dublin",
+      },
+    ],
+  },
+}
+
+const querySchema = object(
+  {
+    _id: {
+      description: "The ID of the query.",
+      type: "string",
+    },
+    datasourceId: {
+      description: "The ID of the datasource 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: Object.values(BaseQueryVerbs),
+    },
+    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"] }
+)
+
+const executeQuerySchema = {
+  description: "The parameters required for executing a query.",
+  type: "object",
+  properties: {
+    parameters: {
+      type: "object",
+      description:
+        "This contains the required parameters for the query, this depends on query type, setup and bindings.",
+      additionalProperties: {
+        description:
+          "Key value properties of any type, depending on the query output schema.",
+      },
+    },
+    pagination: {
+      type: "object",
+      description:
+        "For supported query types (currently on REST) pagination can be performed using these properties.",
+      properties: {
+        page: {
+          type: "string",
+          description:
+            "The page which has been returned from a previous query.",
+        },
+        limit: {
+          type: "number",
+          description: "The number of rows to return per page.",
+        },
+      },
+    },
+  },
+}
+
+const executeQueryOutputSchema = object(
+  {
+    data: {
+      description: "The data response from the query.",
+      type: "array",
+      items: {
+        type: "object",
+      },
+    },
+    extra: {
+      description:
+        "Extra information that is not part of the main data, e.g. headers.",
+      type: "object",
+      properties: {
+        headers: {
+          description:
+            "If carrying out a REST request, this will contain the response headers.",
+          type: "object",
+        },
+        raw: {
+          description: "The raw query response, as a string.",
+          type: "string",
+        },
+      },
+    },
+    pagination: {
+      description:
+        "If pagination is supported, this will contain the bookmark/anchor information for it.",
+      type: "object",
+    },
+  },
+  { required: ["data"] }
+)
+
+export default new Resource()
+  .setExamples({
+    query: {
+      value: {
+        data: query,
+      },
+    },
+    queries: {
+      value: {
+        data: [query],
+      },
+    },
+    restResponse,
+    sqlResponse,
+  })
+  .setSchemas({
+    executeQuery: executeQuerySchema,
+    executeQueryOutput: executeQueryOutputSchema,
+    query: querySchema,
+    querySearch: object({
+      data: {
+        type: "array",
+        items: querySchema,
+      },
+    }),
+  })