@budibase/frontend-core 2.5.6-alpha.5 → 2.5.6-alpha.7

package/src/components/grid/stores/rows.js

@@ -0,0 +1,462 @@
+import { writable, derived, get } from "svelte/store"
+import { fetchData } from "../../../fetch/fetchData"
+import { notifications } from "@budibase/bbui"
+
+const initialSortState = {
+  column: null,
+  order: "ascending",
+}
+
+export const createStores = () => {
+  const rows = writable([])
+  const table = writable(null)
+  const filter = writable([])
+  const loading = writable(false)
+  const loaded = writable(false)
+  const sort = writable(initialSortState)
+  const rowChangeCache = writable({})
+  const inProgressChanges = writable({})
+
+  // Generate a lookup map to quick find a row by ID
+  const rowLookupMap = derived(
+    rows,
+    $rows => {
+      let map = {}
+      for (let i = 0; i < $rows.length; i++) {
+        map[$rows[i]._id] = i
+      }
+      return map
+    },
+    {}
+  )
+
+  // Mark loaded as true if we've ever stopped loading
+  let hasStartedLoading = false
+  loading.subscribe($loading => {
+    if ($loading) {
+      hasStartedLoading = true
+    } else if (hasStartedLoading) {
+      loaded.set(true)
+    }
+  })
+
+  return {
+    rows,
+    rowLookupMap,
+    table,
+    filter,
+    loaded,
+    loading,
+    sort,
+    rowChangeCache,
+    inProgressChanges,
+  }
+}
+
+export const deriveStores = context => {
+  const {
+    rows,
+    rowLookupMap,
+    table,
+    filter,
+    loading,
+    sort,
+    tableId,
+    API,
+    scroll,
+    validation,
+    focusedCellId,
+    columns,
+    rowChangeCache,
+    inProgressChanges,
+    previousFocusedRowId,
+  } = context
+  const instanceLoaded = writable(false)
+  const fetch = writable(null)
+
+  // Local cache of row IDs to speed up checking if a row exists
+  let rowCacheMap = {}
+
+  // Enrich rows with an index property and any pending changes
+  const enrichedRows = derived(
+    [rows, rowChangeCache],
+    ([$rows, $rowChangeCache]) => {
+      return $rows.map((row, idx) => ({
+        ...row,
+        ...$rowChangeCache[row._id],
+        __idx: idx,
+      }))
+    },
+    []
+  )
+
+  // Reset everything when table ID changes
+  let unsubscribe = null
+  let lastResetKey = null
+  tableId.subscribe($tableId => {
+    // Unsub from previous fetch if one exists
+    unsubscribe?.()
+    fetch.set(null)
+    instanceLoaded.set(false)
+    loading.set(true)
+
+    // Reset state
+    filter.set([])
+
+    // Create new fetch model
+    const newFetch = fetchData({
+      API,
+      datasource: {
+        type: "table",
+        tableId: $tableId,
+      },
+      options: {
+        filter: [],
+        sortColumn: initialSortState.column,
+        sortOrder: initialSortState.order,
+        limit: 100,
+        paginate: true,
+      },
+    })
+
+    // Subscribe to changes of this fetch model
+    unsubscribe = newFetch.subscribe($fetch => {
+      if ($fetch.loaded && !$fetch.loading) {
+        const $instanceLoaded = get(instanceLoaded)
+        const resetRows = $fetch.resetKey !== lastResetKey
+        lastResetKey = $fetch.resetKey
+
+        // Reset state properties when dataset changes
+        if (!$instanceLoaded || resetRows) {
+          table.set($fetch.definition)
+          sort.set({
+            column: $fetch.sortColumn,
+            order: $fetch.sortOrder,
+          })
+        }
+
+        // Reset scroll state when data changes
+        if (!$instanceLoaded) {
+          // Reset both top and left for a new table ID
+          instanceLoaded.set(true)
+          scroll.set({ top: 0, left: 0 })
+        } else if (resetRows) {
+          // Only reset top scroll position when resetting rows
+          scroll.update(state => ({ ...state, top: 0 }))
+        }
+
+        // Process new rows
+        handleNewRows($fetch.rows, resetRows)
+
+        // Notify that we're loaded
+        loading.set(false)
+      }
+    })
+
+    fetch.set(newFetch)
+  })
+
+  // Update fetch when filter or sort config changes
+  filter.subscribe($filter => {
+    get(fetch)?.update({
+      filter: $filter,
+    })
+  })
+  sort.subscribe($sort => {
+    get(fetch)?.update({
+      sortOrder: $sort.order,
+      sortColumn: $sort.column,
+    })
+  })
+
+  // Gets a row by ID
+  const getRow = id => {
+    const index = get(rowLookupMap)[id]
+    return index >= 0 ? get(rows)[index] : null
+  }
+
+  // Handles validation errors from the rows API and updates local validation
+  // state, storing error messages against relevant cells
+  const handleValidationError = (rowId, error) => {
+    if (error?.json?.validationErrors) {
+      // Normal validation error
+      const keys = Object.keys(error.json.validationErrors)
+      const $columns = get(columns)
+      for (let column of keys) {
+        validation.actions.setError(
+          `${rowId}-${column}`,
+          `${column} ${error.json.validationErrors[column]}`
+        )
+
+        // Ensure the column is visible
+        const index = $columns.findIndex(x => x.name === column)
+        if (index !== -1 && !$columns[index].visible) {
+          columns.update(state => {
+            state[index].visible = true
+            return state.slice()
+          })
+        }
+      }
+      // Focus the first cell with an error
+      focusedCellId.set(`${rowId}-${keys[0]}`)
+    } else {
+      // Some other error - just update the current cell
+      validation.actions.setError(get(focusedCellId), error?.message || "Error")
+    }
+  }
+
+  // Adds a new row
+  const addRow = async (row, idx, bubble = false) => {
+    try {
+      // Create row
+      let newRow = await API.saveRow({ ...row, tableId: get(tableId) })
+      newRow = await fetchRow(newRow._id)
+
+      // Update state
+      if (idx != null) {
+        rowCacheMap[newRow._id] = true
+        rows.update(state => {
+          state.splice(idx, 0, newRow)
+          return state.slice()
+        })
+      } else {
+        handleNewRows([newRow])
+      }
+
+      // Refresh row to ensure data is in the correct format
+      notifications.success("Row created successfully")
+      return newRow
+    } catch (error) {
+      if (bubble) {
+        throw error
+      } else {
+        handleValidationError("new", error)
+      }
+    }
+  }
+
+  // Duplicates a row, inserting the duplicate row after the existing one
+  const duplicateRow = async row => {
+    let clone = { ...row }
+    delete clone._id
+    delete clone._rev
+    delete clone.__idx
+    try {
+      return await addRow(clone, row.__idx + 1, true)
+    } catch (error) {
+      handleValidationError(row._id, error)
+    }
+  }
+
+  // Fetches a row by ID using the search endpoint
+  const fetchRow = async id => {
+    const res = await API.searchTable({
+      tableId: get(tableId),
+      limit: 1,
+      query: {
+        equal: {
+          _id: id,
+        },
+      },
+      paginate: false,
+    })
+    return res?.rows?.[0]
+  }
+
+  // Refreshes a specific row, handling updates, addition or deletion
+  const refreshRow = async id => {
+    // Fetch row from the server again
+    const newRow = await fetchRow(id)
+
+    // Get index of row to check if it exists
+    const $rows = get(rows)
+    const $rowLookupMap = get(rowLookupMap)
+    const index = $rowLookupMap[id]
+
+    // Process as either an update, addition or deletion
+    if (newRow) {
+      if (index != null) {
+        // An existing row was updated
+        rows.update(state => {
+          state[index] = { ...newRow }
+          return state
+        })
+      } else {
+        // A new row was created
+        handleNewRows([newRow])
+      }
+    } else if (index != null) {
+      // A row was removed
+      handleRemoveRows([$rows[index]])
+    }
+  }
+
+  // Refreshes all data
+  const refreshData = () => {
+    get(fetch)?.getInitialData()
+  }
+
+  // Patches a row with some changes
+  const updateRow = async (rowId, changes) => {
+    const $rows = get(rows)
+    const $rowLookupMap = get(rowLookupMap)
+    const index = $rowLookupMap[rowId]
+    const row = $rows[index]
+    if (index == null || !Object.keys(changes || {}).length) {
+      return
+    }
+
+    // Abandon if no changes
+    let same = true
+    for (let column of Object.keys(changes)) {
+      if (row[column] !== changes[column]) {
+        same = false
+        break
+      }
+    }
+    if (same) {
+      return
+    }
+
+    // Immediately update state so that the change is reflected
+    rowChangeCache.update(state => ({
+      ...state,
+      [rowId]: {
+        ...state[rowId],
+        ...changes,
+      },
+    }))
+
+    // Save change
+    try {
+      inProgressChanges.update(state => ({
+        ...state,
+        [rowId]: true,
+      }))
+      const newRow = { ...row, ...get(rowChangeCache)[rowId] }
+      const saved = await API.saveRow(newRow)
+
+      // Update state after a successful change
+      rows.update(state => {
+        state[index] = {
+          ...newRow,
+          _rev: saved._rev,
+        }
+        return state.slice()
+      })
+      rowChangeCache.update(state => {
+        delete state[rowId]
+        return state
+      })
+    } catch (error) {
+      handleValidationError(rowId, error)
+    }
+    inProgressChanges.update(state => ({
+      ...state,
+      [rowId]: false,
+    }))
+  }
+
+  // Updates a value of a row
+  const updateValue = async (rowId, column, value) => {
+    return await updateRow(rowId, { [column]: value })
+  }
+
+  // Deletes an array of rows
+  const deleteRows = async rowsToDelete => {
+    if (!rowsToDelete?.length) {
+      return
+    }
+
+    // Actually delete rows
+    rowsToDelete.forEach(row => {
+      delete row.__idx
+    })
+    await API.deleteRows({
+      tableId: get(tableId),
+      rows: rowsToDelete,
+    })
+
+    // Update state
+    handleRemoveRows(rowsToDelete)
+  }
+
+  // Local handler to process new rows inside the fetch, and append any new
+  // rows to state that we haven't encountered before
+  const handleNewRows = (newRows, resetRows) => {
+    if (resetRows) {
+      rowCacheMap = {}
+    }
+    let rowsToAppend = []
+    let newRow
+    for (let i = 0; i < newRows.length; i++) {
+      newRow = newRows[i]
+      if (!rowCacheMap[newRow._id]) {
+        rowCacheMap[newRow._id] = true
+        rowsToAppend.push(newRow)
+      }
+    }
+    if (resetRows) {
+      rows.set(rowsToAppend)
+    } else if (rowsToAppend.length) {
+      rows.update(state => [...state, ...rowsToAppend])
+    }
+  }
+
+  // Local handler to remove rows from state
+  const handleRemoveRows = rowsToRemove => {
+    const deletedIds = rowsToRemove.map(row => row._id)
+
+    // We deliberately do not remove IDs from the cache map as the data may
+    // still exist inside the fetch, but we don't want to add it again
+    rows.update(state => {
+      return state.filter(row => !deletedIds.includes(row._id))
+    })
+  }
+
+  // Loads the next page of data if available
+  const loadNextPage = () => {
+    get(fetch)?.nextPage()
+  }
+
+  // Refreshes the schema of the data fetch subscription
+  const refreshTableDefinition = async () => {
+    const definition = await API.fetchTableDefinition(get(tableId))
+    table.set(definition)
+  }
+
+  // Checks if we have a row with a certain ID
+  const hasRow = id => {
+    return get(rowLookupMap)[id] != null
+  }
+
+  // Wipe the row change cache when changing row
+  previousFocusedRowId.subscribe(id => {
+    if (id && !get(inProgressChanges)[id]) {
+      rowChangeCache.update(state => {
+        delete state[id]
+        return state
+      })
+    }
+  })
+
+  return {
+    enrichedRows,
+    rows: {
+      ...rows,
+      actions: {
+        addRow,
+        duplicateRow,
+        getRow,
+        updateValue,
+        updateRow,
+        deleteRows,
+        hasRow,
+        loadNextPage,
+        refreshRow,
+        refreshData,
+        refreshTableDefinition,
+      },
+    },
+  }
+}

package/src/components/grid/stores/scroll.js

@@ -0,0 +1,201 @@
+import { writable, derived, get } from "svelte/store"
+import { tick } from "svelte"
+import { Padding, GutterWidth, DefaultRowHeight } from "../lib/constants"
+
+export const createStores = () => {
+  const scroll = writable({
+    left: 0,
+    top: 0,
+  })
+
+  // Derive height and width as primitives to avoid wasted computation
+  const scrollTop = derived(scroll, $scroll => $scroll.top, 0)
+  const scrollLeft = derived(scroll, $scroll => $scroll.left, 0)
+
+  return {
+    scroll,
+    scrollTop,
+    scrollLeft,
+  }
+}
+
+export const deriveStores = context => {
+  const { rows, visibleColumns, stickyColumn, rowHeight, width, height } =
+    context
+
+  // Memoize store primitives
+  const stickyColumnWidth = derived(stickyColumn, $col => $col?.width || 0, 0)
+
+  // Derive vertical limits
+  const contentHeight = derived(
+    [rows, rowHeight],
+    ([$rows, $rowHeight]) => $rows.length * $rowHeight + Padding,
+    0
+  )
+  const maxScrollTop = derived(
+    [height, contentHeight],
+    ([$height, $contentHeight]) => Math.max($contentHeight - $height, 0),
+    0
+  )
+
+  // Derive horizontal limits
+  const contentWidth = derived(
+    [visibleColumns, stickyColumnWidth],
+    ([$visibleColumns, $stickyColumnWidth]) => {
+      let width = GutterWidth + Padding + $stickyColumnWidth
+      $visibleColumns.forEach(col => {
+        width += col.width
+      })
+      return width
+    },
+    0
+  )
+  const screenWidth = derived(
+    [width, stickyColumnWidth],
+    ([$width, $stickyColumnWidth]) => $width + GutterWidth + $stickyColumnWidth,
+    0
+  )
+  const maxScrollLeft = derived(
+    [contentWidth, screenWidth],
+    ([$contentWidth, $screenWidth]) => {
+      return Math.max($contentWidth - $screenWidth, 0)
+    },
+    0
+  )
+
+  // Derive whether to show scrollbars or not
+  const showVScrollbar = derived(
+    [contentHeight, height],
+    ([$contentHeight, $height]) => {
+      return $contentHeight > $height
+    }
+  )
+  const showHScrollbar = derived(
+    [contentWidth, screenWidth],
+    ([$contentWidth, $screenWidth]) => {
+      return $contentWidth > $screenWidth
+    }
+  )
+
+  return {
+    contentHeight,
+    contentWidth,
+    screenWidth,
+    maxScrollTop,
+    maxScrollLeft,
+    showHScrollbar,
+    showVScrollbar,
+  }
+}
+
+export const initialise = context => {
+  const {
+    focusedCellId,
+    focusedRow,
+    scroll,
+    bounds,
+    rowHeight,
+    visibleColumns,
+    scrollTop,
+    maxScrollTop,
+    scrollLeft,
+    maxScrollLeft,
+  } = context
+
+  // Ensure scroll state never goes invalid, which can happen when changing
+  // rows or tables
+  const overscrollTop = derived(
+    [scrollTop, maxScrollTop],
+    ([$scrollTop, $maxScrollTop]) => $scrollTop > $maxScrollTop,
+    false
+  )
+  const overscrollLeft = derived(
+    [scrollLeft, maxScrollLeft],
+    ([$scrollLeft, $maxScrollLeft]) => $scrollLeft > $maxScrollLeft,
+    false
+  )
+  overscrollTop.subscribe(overscroll => {
+    if (overscroll) {
+      scroll.update(state => ({
+        ...state,
+        top: get(maxScrollTop),
+      }))
+    }
+  })
+  overscrollLeft.subscribe(overscroll => {
+    if (overscroll) {
+      scroll.update(state => ({
+        ...state,
+        left: get(maxScrollLeft),
+      }))
+    }
+  })
+
+  // Ensure the selected cell is visible
+  focusedCellId.subscribe(async $focusedCellId => {
+    await tick()
+    const $focusedRow = get(focusedRow)
+    const $scroll = get(scroll)
+    const $bounds = get(bounds)
+    const $rowHeight = get(rowHeight)
+    const verticalOffset = DefaultRowHeight * 1.5
+
+    // Ensure vertical position is viewable
+    if ($focusedRow) {
+      // Ensure row is not below bottom of screen
+      const rowYPos = $focusedRow.__idx * $rowHeight
+      const bottomCutoff =
+        $scroll.top + $bounds.height - $rowHeight - verticalOffset
+      let delta = rowYPos - bottomCutoff
+      if (delta > 0) {
+        scroll.update(state => ({
+          ...state,
+          top: state.top + delta,
+        }))
+      }
+
+      // Ensure row is not above top of screen
+      else {
+        const delta = $scroll.top - rowYPos + verticalOffset
+        if (delta > 0) {
+          scroll.update(state => ({
+            ...state,
+            top: Math.max(0, state.top - delta),
+          }))
+        }
+      }
+    }
+
+    // Ensure horizontal position is viewable
+    // Check horizontal position of columns next
+    const $visibleColumns = get(visibleColumns)
+    const columnName = $focusedCellId?.split("-")[1]
+    const column = $visibleColumns.find(col => col.name === columnName)
+    const horizontalOffset = 50
+    if (!column) {
+      return
+    }
+
+    // Ensure column is not cutoff on left edge
+    let delta = $scroll.left - column.left + horizontalOffset
+    if (delta > 0) {
+      scroll.update(state => ({
+        ...state,
+        left: Math.max(0, state.left - delta),
+      }))
+    }
+
+    // Ensure column is not cutoff on right edge
+    else {
+      const rightEdge = column.left + column.width
+      const rightBound = $bounds.width + $scroll.left - horizontalOffset
+      delta = rightEdge - rightBound
+      if (delta > 0) {
+        scroll.update(state => ({
+          ...state,
+          left: state.left + delta,
+        }))
+      }
+    }
+  })
+}