@budibase/server 2.1.45 → 2.1.46-alpha.0

package/src/automations/steps/{outgoingWebhook.js → outgoingWebhook.ts}

@@ -1,13 +1,18 @@
-const fetch = require("node-fetch")
-const { getFetchResponse } = require("./utils")
-const automationUtils = require("../automationUtils")
+import fetch from "node-fetch"
+import { getFetchResponse } from "./utils"
+import * as automationUtils from "../automationUtils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-const RequestType = {
-  POST: "POST",
-  GET: "GET",
-  PUT: "PUT",
-  DELETE: "DELETE",
-  PATCH: "PATCH",
+enum RequestType {
+  POST = "POST",
+  GET = "GET",
+  PUT = "PUT",
+  DELETE = "DELETE",
+  PATCH = "PATCH",
 }
 
 const BODY_REQUESTS = [RequestType.POST, RequestType.PUT, RequestType.PATCH]
@@ -16,7 +21,7 @@ const BODY_REQUESTS = [RequestType.POST, RequestType.PUT, RequestType.PATCH]
  * NOTE: this functionality is deprecated - it no longer should be used.
  */
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   deprecated: true,
   name: "Outgoing webhook",
   tagline: "Send a {{inputs.requestMethod}} request",
@@ -24,7 +29,7 @@ exports.definition = {
   description: "Send a request of specified method to a URL",
   type: "ACTION",
   internal: true,
-  stepId: "OUTGOING_WEBHOOK",
+  stepId: AutomationActionStepId.OUTGOING_WEBHOOK,
   inputs: {
     requestMethod: "POST",
     url: "http://",
@@ -76,12 +81,12 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs }) {
+export async function run({ inputs }: AutomationStepInput) {
   let { requestMethod, url, requestBody, headers } = inputs
   if (!url.startsWith("http")) {
     url = `http://${url}`
   }
-  const request = {
+  const request: any = {
     method: requestMethod,
   }
   if (headers) {

package/src/automations/steps/{queryRows.js → queryRows.ts}

@@ -1,36 +1,43 @@
-const rowController = require("../../api/controllers/row")
-const tableController = require("../../api/controllers/table")
-const { FieldTypes } = require("../../constants")
-const { buildCtx } = require("./utils")
-const automationUtils = require("../automationUtils")
+import * as rowController from "../../api/controllers/row"
+import * as tableController from "../../api/controllers/table"
+import { FieldTypes } from "../../constants"
+import { buildCtx } from "./utils"
+import * as automationUtils from "../automationUtils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+  SearchFilters,
+  Table,
+} from "@budibase/types"
 
-const SortOrders = {
-  ASCENDING: "ascending",
-  DESCENDING: "descending",
+enum SortOrder {
+  ASCENDING = "ascending",
+  DESCENDING = "descending",
 }
 
-const SortOrdersPretty = {
-  [SortOrders.ASCENDING]: "Ascending",
-  [SortOrders.DESCENDING]: "Descending",
+const SortOrderPretty = {
+  [SortOrder.ASCENDING]: "Ascending",
+  [SortOrder.DESCENDING]: "Descending",
 }
 
-const EmptyFilterOptions = {
-  RETURN_ALL: "all",
-  RETURN_NONE: "none",
+enum EmptyFilterOption {
+  RETURN_ALL = "all",
+  RETURN_NONE = "none",
 }
 
-const EmptyFilterOptionsPretty = {
-  [EmptyFilterOptions.RETURN_ALL]: "Return all table rows",
-  [EmptyFilterOptions.RETURN_NONE]: "Return no rows",
+const EmptyFilterOptionPretty = {
+  [EmptyFilterOption.RETURN_ALL]: "Return all table rows",
+  [EmptyFilterOption.RETURN_NONE]: "Return no rows",
 }
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   description: "Query rows from the database",
   icon: "Search",
   name: "Query rows",
   tagline: "Query rows from {{inputs.enriched.table.name}} table",
   type: "ACTION",
-  stepId: "QUERY_ROWS",
+  stepId: AutomationActionStepId.QUERY_ROWS,
   internal: true,
   inputs: {},
   schema: {
@@ -54,8 +61,8 @@ exports.definition = {
         sortOrder: {
           type: "string",
           title: "Sort Order",
-          enum: Object.values(SortOrders),
-          pretty: Object.values(SortOrdersPretty),
+          enum: Object.values(SortOrder),
+          pretty: Object.values(SortOrderPretty),
         },
         limit: {
           type: "number",
@@ -63,8 +70,8 @@ exports.definition = {
           customType: "queryLimit",
         },
         onEmptyFilter: {
-          pretty: Object.values(EmptyFilterOptionsPretty),
-          enum: Object.values(EmptyFilterOptions),
+          pretty: Object.values(EmptyFilterOptionPretty),
+          enum: Object.values(EmptyFilterOption),
           type: "string",
           title: "When Filter Empty",
         },
@@ -88,8 +95,8 @@ exports.definition = {
   },
 }
 
-async function getTable(appId, tableId) {
-  const ctx = buildCtx(appId, null, {
+async function getTable(appId: string, tableId: string) {
+  const ctx: any = buildCtx(appId, null, {
     params: {
       tableId,
     },
@@ -98,20 +105,22 @@ async function getTable(appId, tableId) {
   return ctx.body
 }
 
-function typeCoercion(filters, table) {
+function typeCoercion(filters: SearchFilters, table: Table) {
   if (!filters || !table) {
     return filters
   }
   for (let key of Object.keys(filters)) {
-    if (typeof filters[key] === "object") {
-      for (let [property, value] of Object.entries(filters[key])) {
+    // @ts-ignore
+    const searchParam = filters[key]
+    if (typeof searchParam === "object") {
+      for (let [property, value] of Object.entries(searchParam)) {
         const column = table.schema[property]
         // convert string inputs
         if (!column || typeof value !== "string") {
           continue
         }
         if (column.type === FieldTypes.NUMBER) {
-          filters[key][property] = parseFloat(value)
+          searchParam[property] = parseFloat(value)
         }
       }
     }
@@ -119,11 +128,14 @@ function typeCoercion(filters, table) {
   return filters
 }
 
-const hasNullFilters = filters =>
-  filters.length === 0 ||
-  filters.some(filter => filter.value === null || filter.value === "")
+function hasNullFilters(filters: any[]) {
+  return (
+    filters.length === 0 ||
+    filters.some(filter => filter.value === null || filter.value === "")
+  )
+}
 
-exports.run = async function ({ inputs, appId }) {
+export async function run({ inputs, appId }: AutomationStepInput) {
   const { tableId, filters, sortColumn, sortOrder, limit } = inputs
   if (!tableId) {
     return {
@@ -140,7 +152,7 @@ exports.run = async function ({ inputs, appId }) {
     sortType =
       fieldType === FieldTypes.NUMBER ? FieldTypes.NUMBER : FieldTypes.STRING
   }
-  const ctx = buildCtx(appId, null, {
+  const ctx: any = buildCtx(appId, null, {
     params: {
       tableId,
     },
@@ -150,7 +162,7 @@ exports.run = async function ({ inputs, appId }) {
       sort: sortColumn,
       query: typeCoercion(filters || {}, table),
       // default to ascending, like data tab
-      sortOrder: sortOrder || SortOrders.ASCENDING,
+      sortOrder: sortOrder || SortOrder.ASCENDING,
     },
     version: "1",
   })
@@ -158,7 +170,7 @@ exports.run = async function ({ inputs, appId }) {
     let rows
 
     if (
-      inputs.onEmptyFilter === EmptyFilterOptions.RETURN_NONE &&
+      inputs.onEmptyFilter === EmptyFilterOption.RETURN_NONE &&
       inputs["filters-def"] &&
       hasNullFilters(inputs["filters-def"])
     ) {

package/src/automations/steps/{sendSmtpEmail.js → sendSmtpEmail.ts}

@@ -1,14 +1,19 @@
-const { sendSmtpEmail } = require("../../utilities/workerRequests")
-const automationUtils = require("../automationUtils")
+import { sendSmtpEmail } from "../../utilities/workerRequests"
+import * as automationUtils from "../automationUtils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   description: "Send an email using SMTP",
   tagline: "Send SMTP email to {{inputs.to}}",
   icon: "Email",
   name: "Send Email (SMTP)",
   type: "ACTION",
   internal: true,
-  stepId: "SEND_EMAIL_SMTP",
+  stepId: AutomationActionStepId.SEND_EMAIL_SMTP,
   inputs: {},
   schema: {
     inputs: {
@@ -56,7 +61,7 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs }) {
+export async function run({ inputs }: AutomationStepInput) {
   let { to, from, subject, contents, cc, bcc } = inputs
   if (!contents) {
     contents = "<h1>No content</h1>"

package/src/automations/steps/{serverLog.js → serverLog.ts}

@@ -1,17 +1,23 @@
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
+
 /**
  * Note, there is some functionality in this that is not currently exposed as it
  * is complex and maybe better to be opinionated here.
  * GET/DELETE requests cannot handle body elements so they will not be sent if configured.
  */
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   name: "Backend log",
   tagline: "Console log a value in the backend",
   icon: "Monitoring",
   description: "Logs the given text to the server (using console.log)",
   type: "ACTION",
   internal: true,
-  stepId: "SERVER_LOG",
+  stepId: AutomationActionStepId.SERVER_LOG,
   inputs: {
     text: "",
   },
@@ -41,7 +47,7 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs, appId }) {
+export async function run({ inputs, appId }: AutomationStepInput) {
   const message = `App ${appId} - ${inputs.text}`
   console.log(message)
   return {

package/src/automations/steps/{slack.js → slack.ts}

@@ -1,12 +1,17 @@
-const fetch = require("node-fetch")
-const { getFetchResponse } = require("./utils")
+import fetch from "node-fetch"
+import { getFetchResponse } from "./utils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   name: "Slack Message",
   tagline: "Send a message to Slack",
   description: "Send a message to Slack",
   icon: "ri-slack-line",
-  stepId: "slack",
+  stepId: AutomationActionStepId.slack,
   type: "ACTION",
   internal: false,
   inputs: {},
@@ -43,7 +48,7 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs }) {
+export async function run({ inputs }: AutomationStepInput) {
   let { url, text } = inputs
   const response = await fetch(url, {
     method: "post",

package/src/automations/steps/{updateRow.js → updateRow.ts}

@@ -1,15 +1,20 @@
-const rowController = require("../../api/controllers/row")
-const automationUtils = require("../automationUtils")
-const { buildCtx } = require("./utils")
+import * as rowController from "../../api/controllers/row"
+import * as automationUtils from "../automationUtils"
+import { buildCtx } from "./utils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   name: "Update Row",
   tagline: "Update a {{inputs.enriched.table.name}} row",
   icon: "Refresh",
   description: "Update a row in your database",
   type: "ACTION",
   internal: true,
-  stepId: "UPDATE_ROW",
+  stepId: AutomationActionStepId.UPDATE_ROW,
   inputs: {},
   schema: {
     inputs: {
@@ -55,7 +60,7 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs, appId, emitter }) {
+export async function run({ inputs, appId, emitter }: AutomationStepInput) {
   if (inputs.rowId == null || inputs.row == null) {
     return {
       success: false,
@@ -74,7 +79,7 @@ exports.run = async function ({ inputs, appId, emitter }) {
   }
 
   // have to clean up the row, remove the table from it
-  const ctx = buildCtx(appId, emitter, {
+  const ctx: any = buildCtx(appId, emitter, {
     body: {
       ...inputs.row,
       _id: inputs.rowId,

package/src/automations/steps/{utils.js → utils.ts}

@@ -1,4 +1,6 @@
-exports.getFetchResponse = async fetched => {
+import { EventEmitter } from "events"
+
+export async function getFetchResponse(fetched: any) {
   let status = fetched.status,
     message
   const contentType = fetched.headers.get("content-type")
@@ -18,12 +20,16 @@ exports.getFetchResponse = async fetched => {
 // throw added to them, so that controllers don't
 // throw a ctx.throw undefined when error occurs
 // opts can contain, body, params and version
-exports.buildCtx = (appId, emitter, opts = {}) => {
-  const ctx = {
+export function buildCtx(
+  appId: string,
+  emitter?: EventEmitter | null,
+  opts: any = {}
+) {
+  const ctx: any = {
     appId,
     user: { appId },
     eventEmitter: emitter,
-    throw: (code, error) => {
+    throw: (code: string, error: any) => {
       throw error
     },
   }

package/src/automations/steps/{zapier.js → zapier.ts}

@@ -1,14 +1,20 @@
-const fetch = require("node-fetch")
-const { getFetchResponse } = require("./utils")
+import fetch from "node-fetch"
+import { getFetchResponse } from "./utils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   name: "Zapier Webhook",
-  stepId: "zapier",
+  stepId: AutomationActionStepId.zapier,
   type: "ACTION",
   internal: false,
   description: "Trigger a Zapier Zap via webhooks",
   tagline: "Trigger a Zapier Zap",
   icon: "ri-flashlight-line",
+  inputs: {},
   schema: {
     inputs: {
       properties: {
@@ -54,7 +60,7 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs }) {
+export async function run({ inputs }: AutomationStepInput) {
   const { url, value1, value2, value3, value4, value5 } = inputs
 
   // send the platform to make sure zaps always work, even

package/src/automations/tests/updateRow.spec.js

@@ -1,4 +1,3 @@
-const env = require("../../environment")
 const setup = require("./utilities")
 
 describe("test the update row action", () => {

package/src/automations/tests/utilities/index.ts

@@ -0,0 +1,60 @@
+import TestConfig from "../../../tests/utilities/TestConfiguration"
+import { context } from "@budibase/backend-core"
+import { ACTION_DEFINITIONS, getAction } from "../../actions"
+import emitter from "../../../events/index"
+import env from "../../../environment"
+
+let config: any
+
+export function getConfig() {
+  if (!config) {
+    config = new TestConfig(false)
+  }
+  return config
+}
+
+export function afterAll() {
+  config.end()
+}
+
+export async function runInProd(fn: any) {
+  env._set("NODE_ENV", "production")
+  let error
+  try {
+    await fn()
+  } catch (err) {
+    error = err
+  }
+  env._set("NODE_ENV", "jest")
+  if (error) {
+    throw error
+  }
+}
+
+export async function runStep(stepId: string, inputs: any) {
+  async function run() {
+    let step = await getAction(stepId)
+    expect(step).toBeDefined()
+    if (!step) {
+      throw new Error("No step found")
+    }
+    return step({
+      context: {},
+      inputs,
+      appId: config ? config.getAppId() : null,
+      // don't really need an API key, mocked out usage quota, not being tested here
+      apiKey,
+      emitter,
+    })
+  }
+  if (config?.appId) {
+    return context.doInContext(config?.appId, async () => {
+      return run()
+    })
+  } else {
+    return run()
+  }
+}
+
+export const apiKey = "test"
+export const actions = ACTION_DEFINITIONS

package/src/automations/triggerInfo/{app.js → app.ts}

@@ -1,10 +1,15 @@
-exports.definition = {
+import {
+  AutomationTriggerSchema,
+  AutomationTriggerStepId,
+} from "@budibase/types"
+
+export const definition: AutomationTriggerSchema = {
   name: "App Action",
   event: "app:trigger",
   icon: "Apps",
   tagline: "Automation fired from the frontend",
   description: "Trigger an automation from an action inside your app",
-  stepId: "APP",
+  stepId: AutomationTriggerStepId.APP,
   inputs: {},
   schema: {
     inputs: {

package/src/automations/triggerInfo/{cron.js → cron.ts}

@@ -1,10 +1,15 @@
-exports.definition = {
+import {
+  AutomationTriggerSchema,
+  AutomationTriggerStepId,
+} from "@budibase/types"
+
+export const definition: AutomationTriggerSchema = {
   name: "Cron Trigger",
   event: "cron:trigger",
   icon: "Clock",
   tagline: "Cron Trigger (<b>{{inputs.cron}}</b>)",
   description: "Triggers automation on a cron schedule.",
-  stepId: "CRON",
+  stepId: AutomationTriggerStepId.CRON,
   inputs: {},
   schema: {
     inputs: {

package/src/automations/triggerInfo/index.ts

@@ -0,0 +1,15 @@
+import * as app from "./app"
+import * as cron from "./cron"
+import * as rowDeleted from "./rowDeleted"
+import * as rowSaved from "./rowSaved"
+import * as rowUpdated from "./rowUpdated"
+import * as webhook from "./webhook"
+
+export const definitions = {
+  ROW_SAVED: rowSaved.definition,
+  ROW_UPDATED: rowUpdated.definition,
+  ROW_DELETED: rowDeleted.definition,
+  WEBHOOK: webhook.definition,
+  APP: app.definition,
+  CRON: cron.definition,
+}

package/src/automations/triggerInfo/{rowDeleted.js → rowDeleted.ts}

@@ -1,10 +1,15 @@
-exports.definition = {
+import {
+  AutomationTriggerSchema,
+  AutomationTriggerStepId,
+} from "@budibase/types"
+
+export const definition: AutomationTriggerSchema = {
   name: "Row Deleted",
   event: "row:delete",
   icon: "TableRowRemoveCenter",
   tagline: "Row is deleted from {{inputs.enriched.table.name}}",
   description: "Fired when a row is deleted from your database",
-  stepId: "ROW_DELETED",
+  stepId: AutomationTriggerStepId.ROW_DELETED,
   inputs: {},
   schema: {
     inputs: {

package/src/automations/triggerInfo/{rowSaved.js → rowSaved.ts}

@@ -1,10 +1,15 @@
-exports.definition = {
+import {
+  AutomationTriggerSchema,
+  AutomationTriggerStepId,
+} from "@budibase/types"
+
+export const definition: AutomationTriggerSchema = {
   name: "Row Created",
   event: "row:save",
   icon: "TableRowAddBottom",
   tagline: "Row is added to {{inputs.enriched.table.name}}",
   description: "Fired when a row is added to your database",
-  stepId: "ROW_SAVED",
+  stepId: AutomationTriggerStepId.ROW_SAVED,
   inputs: {},
   schema: {
     inputs: {

package/src/automations/triggerInfo/{rowUpdated.js → rowUpdated.ts}

@@ -1,10 +1,15 @@
-exports.definition = {
+import {
+  AutomationTriggerSchema,
+  AutomationTriggerStepId,
+} from "@budibase/types"
+
+export const definition: AutomationTriggerSchema = {
   name: "Row Updated",
   event: "row:update",
   icon: "Refresh",
   tagline: "Row is updated in {{inputs.enriched.table.name}}",
   description: "Fired when a row is updated in your database",
-  stepId: "ROW_UPDATED",
+  stepId: AutomationTriggerStepId.ROW_UPDATED,
   inputs: {},
   schema: {
     inputs: {

package/src/automations/triggerInfo/{webhook.js → webhook.ts}

@@ -1,10 +1,15 @@
-exports.definition = {
+import {
+  AutomationTriggerSchema,
+  AutomationTriggerStepId,
+} from "@budibase/types"
+
+export const definition: AutomationTriggerSchema = {
   name: "Webhook",
   event: "web:trigger",
   icon: "Send",
   tagline: "Webhook endpoint is hit",
   description: "Trigger an automation when a HTTP POST webhook is hit",
-  stepId: "WEBHOOK",
+  stepId: AutomationTriggerStepId.WEBHOOK,
   inputs: {},
   schema: {
     inputs: {