@budibase/frontend-core 3.8.0 → 3.8.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@budibase/frontend-core",
-  "version": "3.8.0",
+  "version": "3.8.2",
   "description": "Budibase frontend core libraries used in builder and client",
   "author": "Budibase",
   "license": "MPL-2.0",
@@ -17,5 +17,5 @@
     "shortid": "2.2.15",
     "socket.io-client": "^4.7.5"
   },
-  "gitHead": "9bf4efcee5ec5016aeafacbf1ea2bb32b08d922d"
+  "gitHead": "de9bbc8e465a6c939bf23c2fde11a4ce80cbc709"
 }

package/src/components/grid/cells/NumberCell.svelte

@@ -1,8 +1,5 @@
-<script context="module">
-  const NumberFormatter = Intl.NumberFormat()
-</script>
-
 <script>
+  import { formatNumber } from "@budibase/frontend-core"
   import TextCell from "./TextCell.svelte"
 
   export let api
@@ -13,18 +10,6 @@
     const newValue = isNaN(float) ? null : float
     onChange(newValue)
   }
-
-  const formatNumber = value => {
-    const type = typeof value
-    if (type !== "string" && type !== "number") {
-      return ""
-    }
-    if (type === "string" && !value.trim().length) {
-      return ""
-    }
-    const res = NumberFormatter.format(value)
-    return res === "NaN" ? value : res
-  }
 </script>
 
 <TextCell

package/src/utils/formatting.ts

@@ -0,0 +1,149 @@
+import {
+  BBReferenceFieldSubType,
+  FieldSchema,
+  FieldType,
+  Row,
+  TableSchema,
+} from "@budibase/types"
+import { Helpers } from "@budibase/bbui"
+
+// Singleton formatter to save us creating one every time
+const NumberFormatter = Intl.NumberFormat()
+
+export type StringifiedRow = { [key: string]: string }
+
+// Formats a number according to the locale
+export const formatNumber = (value: any): string => {
+  const type = typeof value
+  if (type !== "string" && type !== "number") {
+    return ""
+  }
+  if (type === "string" && !value.trim().length) {
+    return ""
+  }
+  const res = NumberFormatter.format(value)
+  return res === "NaN" ? stringifyValue(value) : res
+}
+
+// Attempts to stringify any type of value
+const stringifyValue = (value: any): string => {
+  if (value == null) {
+    return ""
+  }
+  if (typeof value === "string") {
+    return value
+  }
+  if (typeof value.toString === "function") {
+    return stringifyValue(value.toString())
+  }
+  try {
+    return JSON.stringify(value)
+  } catch (e) {
+    return ""
+  }
+}
+
+const stringifyField = (value: any, schema: FieldSchema): string => {
+  switch (schema.type) {
+    // Auto should not exist as it should always be typed by its underlying
+    // real type, like date or user
+    case FieldType.AUTO:
+      return ""
+
+    // Just state whether signatures exist or not
+    case FieldType.SIGNATURE_SINGLE:
+      return value ? "Yes" : "No"
+
+    // Extract attachment names
+    case FieldType.ATTACHMENT_SINGLE:
+    case FieldType.ATTACHMENTS: {
+      if (!value) {
+        return ""
+      }
+      const arrayValue = Array.isArray(value) ? value : [value]
+      return arrayValue
+        .map(x => x.name)
+        .filter(x => !!x)
+        .join(", ")
+    }
+
+    // Extract primary displays from relationships
+    case FieldType.LINK: {
+      if (!value) {
+        return ""
+      }
+      const arrayValue = Array.isArray(value) ? value : [value]
+      return arrayValue
+        .map(x => x.primaryDisplay)
+        .filter(x => !!x)
+        .join(", ")
+    }
+
+    // Stringify JSON blobs
+    case FieldType.JSON:
+      return value ? JSON.stringify(value) : ""
+
+    // User is the only BB reference subtype right now
+    case FieldType.BB_REFERENCE:
+    case FieldType.BB_REFERENCE_SINGLE: {
+      if (
+        schema.subtype !== BBReferenceFieldSubType.USERS &&
+        schema.subtype !== BBReferenceFieldSubType.USER
+      ) {
+        return ""
+      }
+      if (!value) {
+        return ""
+      }
+      const arrayVal = Array.isArray(value) ? value : [value]
+      return arrayVal?.map((user: any) => user.primaryDisplay).join(", ") || ""
+    }
+
+    // Join arrays with commas
+    case FieldType.ARRAY:
+      return value?.join(", ") || ""
+
+    // Just capitalise booleans
+    case FieldType.BOOLEAN:
+      return Helpers.capitalise(value?.toString() || "false")
+
+    // Format dates into something readable
+    case FieldType.DATETIME: {
+      return Helpers.getDateDisplayValue(value, {
+        enableTime: !schema.dateOnly,
+        timeOnly: schema.timeOnly,
+      })
+    }
+
+    // Format numbers using a locale string
+    case FieldType.NUMBER:
+      return formatNumber(value)
+
+    // Simple string types
+    case FieldType.STRING:
+    case FieldType.LONGFORM:
+    case FieldType.BIGINT:
+    case FieldType.OPTIONS:
+    case FieldType.AI:
+    case FieldType.BARCODEQR:
+      return value || ""
+
+    // Fallback for unknown types or future column types that we forget to add
+    case FieldType.FORMULA:
+    default:
+      return stringifyValue(value)
+  }
+}
+
+// Stringifies every property of a row, ensuring they are all human-readable
+// strings for display
+export const stringifyRow = (row: Row, schema: TableSchema): StringifiedRow => {
+  let stringified: StringifiedRow = {}
+  Object.entries(schema).forEach(([field, fieldSchema]) => {
+    stringified[field] = stringifyField(
+      Helpers.deepGet(row, field),
+      fieldSchema
+    )
+  })
+  return stringified
+}

package/src/utils/index.ts

@@ -15,3 +15,4 @@ export * from "./relatedColumns"
 export * from "./table"
 export * from "./components"
 export * from "./validation"
+export * from "./formatting"

package/src/utils/schema.js

@@ -1,5 +1,6 @@
 import { helpers } from "@budibase/shared-core"
 import { TypeIconMap } from "../constants"
+import { convertJSONSchemaToTableSchema } from "./json"
 
 export const getColumnIcon = column => {
   // For some reason we have remix icons saved under this property sometimes,
@@ -24,3 +25,25 @@ export const getColumnIcon = column => {
 
   return result || "Text"
 }
+
+export const addNestedJSONSchemaFields = schema => {
+  if (!schema) {
+    return schema
+  }
+  let jsonAdditions = {}
+  Object.keys(schema).forEach(fieldKey => {
+    const fieldSchema = schema[fieldKey]
+    if (fieldSchema?.type === "json") {
+      const jsonSchema = convertJSONSchemaToTableSchema(fieldSchema, {
+        squashObjects: true,
+      })
+      Object.keys(jsonSchema).forEach(jsonKey => {
+        jsonAdditions[`${fieldKey}.${jsonKey}`] = {
+          type: jsonSchema[jsonKey].type,
+          nestedJSON: true,
+        }
+      })
+    }
+  })
+  return { ...schema, ...jsonAdditions }
+}