@budibase/server 1.2.35 → 1.2.38

package/src/db/utils.js

@@ -1,6 +1,6 @@
 const newid = require("./newid")
 const {
-  DocumentTypes: CoreDocTypes,
+  DocumentType: CoreDocTypes,
   getRoleParams,
   generateRoleID,
   APP_DEV_PREFIX,
@@ -12,7 +12,7 @@ const {
   getDevelopmentAppID,
   generateAppID,
   getQueryIndex,
-  ViewNames,
+  ViewName,
 } = require("@budibase/backend-core/db")
 
 const UNICODE_MAX = "\ufff0"
@@ -23,7 +23,7 @@ const AppStatus = {
   DEPLOYED: "published",
 }
 
-const DocumentTypes = {
+const DocumentType = {
   ...CoreDocTypes,
   TABLE: "ta",
   ROW: "ro",
@@ -66,12 +66,12 @@ exports.APP_PREFIX = APP_PREFIX
 exports.APP_DEV_PREFIX = APP_DEV_PREFIX
 exports.isDevAppID = isDevAppID
 exports.isProdAppID = isProdAppID
-exports.USER_METDATA_PREFIX = `${DocumentTypes.ROW}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`
-exports.LINK_USER_METADATA_PREFIX = `${DocumentTypes.LINK}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`
-exports.TABLE_ROW_PREFIX = `${DocumentTypes.ROW}${SEPARATOR}${DocumentTypes.TABLE}`
-exports.ViewNames = ViewNames
+exports.USER_METDATA_PREFIX = `${DocumentType.ROW}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`
+exports.LINK_USER_METADATA_PREFIX = `${DocumentType.LINK}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`
+exports.TABLE_ROW_PREFIX = `${DocumentType.ROW}${SEPARATOR}${DocumentType.TABLE}`
+exports.ViewName = ViewName
 exports.InternalTables = InternalTables
-exports.DocumentTypes = DocumentTypes
+exports.DocumentType = DocumentType
 exports.SEPARATOR = SEPARATOR
 exports.UNICODE_MAX = UNICODE_MAX
 exports.SearchIndexes = SearchIndexes
@@ -114,7 +114,7 @@ exports.getDocParams = getDocParams
  * Gets parameters for retrieving tables, this is a utility function for the getDocParams function.
  */
 exports.getTableParams = (tableId = null, otherProps = {}) => {
-  return getDocParams(DocumentTypes.TABLE, tableId, otherProps)
+  return getDocParams(DocumentType.TABLE, tableId, otherProps)
 }
 
 /**
@@ -122,7 +122,7 @@ exports.getTableParams = (tableId = null, otherProps = {}) => {
  * @returns {string} The new table ID which the table doc can be stored under.
  */
 exports.generateTableID = () => {
-  return `${DocumentTypes.TABLE}${SEPARATOR}${newid()}`
+  return `${DocumentType.TABLE}${SEPARATOR}${newid()}`
 }
 
 /**
@@ -135,12 +135,12 @@ exports.generateTableID = () => {
  */
 exports.getRowParams = (tableId = null, rowId = null, otherProps = {}) => {
   if (tableId == null) {
-    return getDocParams(DocumentTypes.ROW, null, otherProps)
+    return getDocParams(DocumentType.ROW, null, otherProps)
   }
 
   const endOfKey = rowId == null ? `${tableId}${SEPARATOR}` : rowId
 
-  return getDocParams(DocumentTypes.ROW, endOfKey, otherProps)
+  return getDocParams(DocumentType.ROW, endOfKey, otherProps)
 }
 
 /**
@@ -150,9 +150,9 @@ exports.getRowParams = (tableId = null, rowId = null, otherProps = {}) => {
  */
 exports.getTableIDFromRowID = rowId => {
   const components = rowId
-    .split(DocumentTypes.TABLE + SEPARATOR)[1]
+    .split(DocumentType.TABLE + SEPARATOR)[1]
     .split(SEPARATOR)
-  return `${DocumentTypes.TABLE}${SEPARATOR}${components[0]}`
+  return `${DocumentType.TABLE}${SEPARATOR}${components[0]}`
 }
 
 /**
@@ -163,7 +163,7 @@ exports.getTableIDFromRowID = rowId => {
  */
 exports.generateRowID = (tableId, id = null) => {
   id = id || newid()
-  return `${DocumentTypes.ROW}${SEPARATOR}${tableId}${SEPARATOR}${id}`
+  return `${DocumentType.ROW}${SEPARATOR}${tableId}${SEPARATOR}${id}`
 }
 
 /**
@@ -186,7 +186,7 @@ exports.generateUserMetadataID = globalId => {
  * Breaks up the ID to get the global ID.
  */
 exports.getGlobalIDFromUserMetadataID = id => {
-  const prefix = `${DocumentTypes.ROW}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`
+  const prefix = `${DocumentType.ROW}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`
   if (!id || !id.includes(prefix)) {
     return id
   }
@@ -197,7 +197,7 @@ exports.getGlobalIDFromUserMetadataID = id => {
  * Gets parameters for retrieving automations, this is a utility function for the getDocParams function.
  */
 exports.getAutomationParams = (automationId = null, otherProps = {}) => {
-  return getDocParams(DocumentTypes.AUTOMATION, automationId, otherProps)
+  return getDocParams(DocumentType.AUTOMATION, automationId, otherProps)
 }
 
 /**
@@ -205,7 +205,7 @@ exports.getAutomationParams = (automationId = null, otherProps = {}) => {
  * @returns {string} The new automation ID which the automation doc can be stored under.
  */
 exports.generateAutomationID = () => {
-  return `${DocumentTypes.AUTOMATION}${SEPARATOR}${newid()}`
+  return `${DocumentType.AUTOMATION}${SEPARATOR}${newid()}`
 }
 
 /**
@@ -230,14 +230,14 @@ exports.generateLinkID = (
   const tables = `${SEPARATOR}${tableId1}${SEPARATOR}${tableId2}`
   const rows = `${SEPARATOR}${rowId1}${SEPARATOR}${rowId2}`
   const fields = `${SEPARATOR}${fieldName1}${SEPARATOR}${fieldName2}`
-  return `${DocumentTypes.LINK}${tables}${rows}${fields}`
+  return `${DocumentType.LINK}${tables}${rows}${fields}`
 }
 
 /**
  * Gets parameters for retrieving link docs, this is a utility function for the getDocParams function.
  */
 exports.getLinkParams = (otherProps = {}) => {
-  return getDocParams(DocumentTypes.LINK, null, otherProps)
+  return getDocParams(DocumentType.LINK, null, otherProps)
 }
 
 /**
@@ -245,14 +245,14 @@ exports.getLinkParams = (otherProps = {}) => {
  * @returns {string} The new layout ID which the layout doc can be stored under.
  */
 exports.generateLayoutID = id => {
-  return `${DocumentTypes.LAYOUT}${SEPARATOR}${id || newid()}`
+  return `${DocumentType.LAYOUT}${SEPARATOR}${id || newid()}`
 }
 
 /**
  * Gets parameters for retrieving layout, this is a utility function for the getDocParams function.
  */
 exports.getLayoutParams = (layoutId = null, otherProps = {}) => {
-  return getDocParams(DocumentTypes.LAYOUT, layoutId, otherProps)
+  return getDocParams(DocumentType.LAYOUT, layoutId, otherProps)
 }
 
 /**
@@ -260,14 +260,14 @@ exports.getLayoutParams = (layoutId = null, otherProps = {}) => {
  * @returns {string} The new screen ID which the screen doc can be stored under.
  */
 exports.generateScreenID = () => {
-  return `${DocumentTypes.SCREEN}${SEPARATOR}${newid()}`
+  return `${DocumentType.SCREEN}${SEPARATOR}${newid()}`
 }
 
 /**
  * Gets parameters for retrieving screens, this is a utility function for the getDocParams function.
  */
 exports.getScreenParams = (screenId = null, otherProps = {}) => {
-  return getDocParams(DocumentTypes.SCREEN, screenId, otherProps)
+  return getDocParams(DocumentType.SCREEN, screenId, otherProps)
 }
 
 /**
@@ -275,14 +275,14 @@ exports.getScreenParams = (screenId = null, otherProps = {}) => {
  * @returns {string} The new webhook ID which the webhook doc can be stored under.
  */
 exports.generateWebhookID = () => {
-  return `${DocumentTypes.WEBHOOK}${SEPARATOR}${newid()}`
+  return `${DocumentType.WEBHOOK}${SEPARATOR}${newid()}`
 }
 
 /**
  * Gets parameters for retrieving a webhook, this is a utility function for the getDocParams function.
  */
 exports.getWebhookParams = (webhookId = null, otherProps = {}) => {
-  return getDocParams(DocumentTypes.WEBHOOK, webhookId, otherProps)
+  return getDocParams(DocumentType.WEBHOOK, webhookId, otherProps)
 }
 
 /**
@@ -291,7 +291,7 @@ exports.getWebhookParams = (webhookId = null, otherProps = {}) => {
  */
 exports.generateDatasourceID = ({ plus = false } = {}) => {
   return `${
-    plus ? DocumentTypes.DATASOURCE_PLUS : DocumentTypes.DATASOURCE
+    plus ? DocumentType.DATASOURCE_PLUS : DocumentType.DATASOURCE
   }${SEPARATOR}${newid()}`
 }
 
@@ -299,7 +299,7 @@ exports.generateDatasourceID = ({ plus = false } = {}) => {
  * Gets parameters for retrieving a datasource, this is a utility function for the getDocParams function.
  */
 exports.getDatasourceParams = (datasourceId = null, otherProps = {}) => {
-  return getDocParams(DocumentTypes.DATASOURCE, datasourceId, otherProps)
+  return getDocParams(DocumentType.DATASOURCE, datasourceId, otherProps)
 }
 
 /**
@@ -308,7 +308,7 @@ exports.getDatasourceParams = (datasourceId = null, otherProps = {}) => {
  */
 exports.generateQueryID = datasourceId => {
   return `${
-    DocumentTypes.QUERY
+    DocumentType.QUERY
   }${SEPARATOR}${datasourceId}${SEPARATOR}${newid()}`
 }
 
@@ -317,14 +317,14 @@ exports.generateQueryID = datasourceId => {
  * automations etc.
  */
 exports.generateAutomationMetadataID = automationId => {
-  return `${DocumentTypes.AUTOMATION_METADATA}${SEPARATOR}${automationId}`
+  return `${DocumentType.AUTOMATION_METADATA}${SEPARATOR}${automationId}`
 }
 
 /**
  * Retrieve all automation metadata in an app database.
  */
 exports.getAutomationMetadataParams = (otherProps = {}) => {
-  return getDocParams(DocumentTypes.AUTOMATION_METADATA, null, otherProps)
+  return getDocParams(DocumentType.AUTOMATION_METADATA, null, otherProps)
 }
 
 /**
@@ -332,11 +332,11 @@ exports.getAutomationMetadataParams = (otherProps = {}) => {
  */
 exports.getQueryParams = (datasourceId = null, otherProps = {}) => {
   if (datasourceId == null) {
-    return getDocParams(DocumentTypes.QUERY, null, otherProps)
+    return getDocParams(DocumentType.QUERY, null, otherProps)
   }
 
   return getDocParams(
-    DocumentTypes.QUERY,
+    DocumentType.QUERY,
     `${datasourceId}${SEPARATOR}`,
     otherProps
   )
@@ -347,11 +347,11 @@ exports.getQueryParams = (datasourceId = null, otherProps = {}) => {
  * @returns {string} The ID of the flag document that was generated.
  */
 exports.generateUserFlagID = userId => {
-  return `${DocumentTypes.USER_FLAG}${SEPARATOR}${userId}`
+  return `${DocumentType.USER_FLAG}${SEPARATOR}${userId}`
 }
 
 exports.generateMetadataID = (type, entityId) => {
-  return `${DocumentTypes.METADATA}${SEPARATOR}${type}${SEPARATOR}${entityId}`
+  return `${DocumentType.METADATA}${SEPARATOR}${type}${SEPARATOR}${entityId}`
 }
 
 exports.getMetadataParams = (type, entityId = null, otherProps = {}) => {
@@ -359,15 +359,15 @@ exports.getMetadataParams = (type, entityId = null, otherProps = {}) => {
   if (entityId != null) {
     docId += entityId
   }
-  return getDocParams(DocumentTypes.METADATA, docId, otherProps)
+  return getDocParams(DocumentType.METADATA, docId, otherProps)
 }
 
 exports.generateMemoryViewID = viewName => {
-  return `${DocumentTypes.MEM_VIEW}${SEPARATOR}${viewName}`
+  return `${DocumentType.MEM_VIEW}${SEPARATOR}${viewName}`
 }
 
 exports.getMemoryViewParams = (otherProps = {}) => {
-  return getDocParams(DocumentTypes.MEM_VIEW, null, otherProps)
+  return getDocParams(DocumentType.MEM_VIEW, null, otherProps)
 }
 
 /**

package/src/db/views/staticViews.js

@@ -1,11 +1,6 @@
 const { getAppDB } = require("@budibase/backend-core/context")
-const {
-  DocumentTypes,
-  SEPARATOR,
-  ViewNames,
-  SearchIndexes,
-} = require("../utils")
-const SCREEN_PREFIX = DocumentTypes.SCREEN + SEPARATOR
+const { DocumentType, SEPARATOR, ViewName, SearchIndexes } = require("../utils")
+const SCREEN_PREFIX = DocumentType.SCREEN + SEPARATOR
 
 /**************************************************
  *                  INFORMATION                   *
@@ -53,7 +48,7 @@ exports.createLinkView = async () => {
   }
   designDoc.views = {
     ...designDoc.views,
-    [ViewNames.LINK]: view,
+    [ViewName.LINK]: view,
   }
   await db.put(designDoc)
 }
@@ -74,7 +69,7 @@ exports.createRoutingView = async () => {
   }
   designDoc.views = {
     ...designDoc.views,
-    [ViewNames.ROUTING]: view,
+    [ViewName.ROUTING]: view,
   }
   await db.put(designDoc)
 }

package/src/definitions/automations.ts

@@ -5,14 +5,14 @@ import {
   Document,
 } from "@budibase/types"
 
-export enum LoopStepTypes {
+export enum LoopStepType {
   ARRAY = "Array",
   STRING = "String",
 }
 
 export interface LoopStep extends AutomationStep {
   inputs: {
-    option: LoopStepTypes
+    option: LoopStepType
     [key: string]: any
   }
 }

package/src/definitions/common.ts

@@ -1,70 +1,19 @@
-export { Query, Datasource } from "./datasource"
-
-export interface Base {
-  _id?: string
-  _rev?: string
-}
-
-export interface Application extends Base {
+import { Document } from "@budibase/types"
+export {
+  Query,
+  Datasource,
+  FieldSchema,
+  TableSchema,
+  Table,
+  Document,
+  Row,
+} from "@budibase/types"
+
+export interface Application extends Document {
+  _id: string
   appId?: string
 }
 
-export interface FieldSchema {
-  // TODO: replace with field types enum when done
-  type: string
-  externalType?: string
-  fieldName?: string
-  name: string
-  tableId?: string
-  relationshipType?: string
-  through?: string
-  foreignKey?: string
-  autocolumn?: boolean
-  subtype?: string
-  throughFrom?: string
-  throughTo?: string
-  formula?: string
-  formulaType?: string
-  main?: boolean
-  ignoreTimezones?: boolean
-  meta?: {
-    toTable: string
-    toKey: string
-  }
-  constraints?: {
-    type?: string
-    email?: boolean
-    inclusion?: string[]
-    length?: {
-      minimum?: string | number
-      maximum?: string | number
-    }
-    presence?: boolean
-  }
-}
-
-export interface TableSchema {
-  [key: string]: FieldSchema
-}
-
-export interface Table extends Base {
-  type?: string
-  views?: {}
-  name: string
-  primary?: string[]
-  schema: TableSchema
-  primaryDisplay?: string
-  sourceId?: string
-  relatedFormula?: string[]
-  constrained?: string[]
-}
-
-export interface Row extends Base {
-  type?: string
-  tableId?: string
-  [key: string]: any
-}
-
 interface JsonSchemaField {
   properties: {
     [key: string]: {
@@ -94,7 +43,7 @@ export interface AutomationStep {
   type: string
 }
 
-export interface Automation extends Base {
+export interface Automation extends Document {
   name: string
   type: string
   appId?: string

package/src/definitions/datasource.ts

@@ -1,214 +1,13 @@
-import { Row, Table, Base } from "./common"
-
-export enum Operation {
-  CREATE = "CREATE",
-  READ = "READ",
-  UPDATE = "UPDATE",
-  DELETE = "DELETE",
-  BULK_CREATE = "BULK_CREATE",
-  CREATE_TABLE = "CREATE_TABLE",
-  UPDATE_TABLE = "UPDATE_TABLE",
-  DELETE_TABLE = "DELETE_TABLE",
-}
-
-export enum SortDirection {
-  ASCENDING = "ASCENDING",
-  DESCENDING = "DESCENDING",
-}
-
-export enum QueryTypes {
-  SQL = "sql",
-  JSON = "json",
-  FIELDS = "fields",
-}
-
-export enum DatasourceFieldTypes {
-  STRING = "string",
-  LONGFORM = "longForm",
-  BOOLEAN = "boolean",
-  NUMBER = "number",
-  PASSWORD = "password",
-  LIST = "list",
-  OBJECT = "object",
-  JSON = "json",
-  FILE = "file",
-}
-
-export enum SourceNames {
-  POSTGRES = "POSTGRES",
-  DYNAMODB = "DYNAMODB",
-  MONGODB = "MONGODB",
-  ELASTICSEARCH = "ELASTICSEARCH",
-  COUCHDB = "COUCHDB",
-  SQL_SERVER = "SQL_SERVER",
-  S3 = "S3",
-  AIRTABLE = "AIRTABLE",
-  MYSQL = "MYSQL",
-  ARANGODB = "ARANGODB",
-  REST = "REST",
-  ORACLE = "ORACLE",
-  GOOGLE_SHEETS = "GOOGLE_SHEETS",
-  FIRESTORE = "FIRESTORE",
-  REDIS = "REDIS",
-  SNOWFLAKE = "SNOWFLAKE",
-}
-
-export enum IncludeRelationships {
-  INCLUDE = 1,
-  EXCLUDE = 0,
-}
-
-export enum FilterTypes {
-  STRING = "string",
-  FUZZY = "fuzzy",
-  RANGE = "range",
-  EQUAL = "equal",
-  NOT_EQUAL = "notEqual",
-  EMPTY = "empty",
-  NOT_EMPTY = "notEmpty",
-  ONE_OF = "oneOf",
-}
-
-export interface QueryDefinition {
-  type: QueryTypes
-  displayName?: string
-  readable?: boolean
-  customisable?: boolean
-  fields?: object
-  urlDisplay?: boolean
-}
-
-export interface ExtraQueryConfig {
-  [key: string]: {
-    displayName: string
-    type: string
-    required: boolean
-    data?: object
-  }
-}
-
-export interface Integration {
-  docs: string
-  plus?: boolean
-  auth?: { type: string }
-  relationships?: boolean
-  description: string
-  friendlyName: string
-  type?: string
-  datasource: {}
-  query: {
-    [key: string]: QueryDefinition
-  }
-  extra?: ExtraQueryConfig
-}
-
-export interface SearchFilters {
-  allOr?: boolean
-  string?: {
-    [key: string]: string
-  }
-  fuzzy?: {
-    [key: string]: string
-  }
-  range?: {
-    [key: string]: {
-      high: number | string
-      low: number | string
-    }
-  }
-  equal?: {
-    [key: string]: any
-  }
-  notEqual?: {
-    [key: string]: any
-  }
-  empty?: {
-    [key: string]: any
-  }
-  notEmpty?: {
-    [key: string]: any
-  }
-  oneOf?: {
-    [key: string]: any[]
-  }
-  contains?: {
-    [key: string]: any
-  }
-}
-
-export interface SortJson {
-  [key: string]: SortDirection
-}
-
-export interface PaginationJson {
-  limit: number
-  page?: string | number
-}
-
-export interface RenameColumn {
-  old: string
-  updated: string
-}
-
-export interface RelationshipsJson {
-  through?: string
-  from?: string
-  to?: string
-  fromPrimary?: string
-  toPrimary?: string
-  tableName: string
-  column: string
-}
-
-export interface QueryJson {
-  endpoint: {
-    datasourceId: string
-    entityId: string
-    operation: Operation
-    schema?: string
-  }
-  resource: {
-    fields: string[]
-  }
-  filters?: SearchFilters
-  sort?: SortJson
-  paginate?: PaginationJson
-  body?: Row | Row[]
-  table?: Table
-  meta?: {
-    table?: Table
-    tables?: Record<string, Table>
-    renamed: RenameColumn
-  }
-  extra?: {
-    idFilter?: SearchFilters
-  }
-  relationships?: RelationshipsJson[]
-}
-
-export interface SqlQuery {
-  sql: string
-  bindings?: string[]
-}
+/********************************************
+ * This file contains structures which are  *
+ * internal to the server and don't need to *
+ * be exposed for use by other services.    *
+ ********************************************/
 
 export interface QueryOptions {
   disableReturning?: boolean
 }
 
-export interface Datasource extends Base {
-  type: string
-  name: string
-  source: SourceNames
-  // the config is defined by the schema
-  config: {
-    [key: string]: string | number | boolean
-  }
-  plus: boolean
-  entities?: {
-    [key: string]: Table
-  }
-}
-
 export enum AuthType {
   BASIC = "basic",
   BEARER = "bearer",
@@ -230,25 +29,6 @@ export interface BearerAuthConfig {
   token: string
 }
 
-export interface QueryParameter {
-  name: string
-  default: string
-}
-
-export interface RestQueryFields {
-  path: string
-  queryString?: string
-  headers: { [key: string]: any }
-  disabledHeaders: { [key: string]: any }
-  requestBody: any
-  bodyType: string
-  json: object
-  method: string
-  authConfigId: string
-  pagination: PaginationConfig | null
-  paginationValues: PaginationValues | null
-}
-
 export interface RestConfig {
   url: string
   defaultHeaders: {
@@ -266,28 +46,3 @@ export interface RestConfig {
     }
   ]
 }
-
-export interface PaginationConfig {
-  type: string
-  location: string
-  pageParam: string
-  sizeParam: string | null
-  responseParam: string | null
-}
-
-export interface PaginationValues {
-  page: string | number | null
-  limit: number | null
-}
-
-export interface Query {
-  _id?: string
-  datasourceId: string
-  name: string
-  parameters: QueryParameter[]
-  fields: RestQueryFields | any
-  transformer: string | null
-  schema: any
-  readable: boolean
-  queryVerb: string
-}