Merge pull request #15330 from Budibase/builder-store-conversions-pc

Convert views and published stores to TS

packages/builder/src/stores/builder/permissions.js

@@ -1,27 +0,0 @@
-import { writable } from "svelte/store"
-import { API } from "@/api"
-
-export function createPermissionStore() {
-  const { subscribe } = writable([])
-
-  return {
-    subscribe,
-    save: async ({ level, role, resource }) => {
-      return await API.updatePermissionForResource(resource, role, level)
-    },
-    remove: async ({ level, role, resource }) => {
-      return await API.removePermissionFromResource(resource, role, level)
-    },
-    forResource: async resourceId => {
-      return (await API.getPermissionForResource(resourceId)).permissions
-    },
-    forResourceDetailed: async resourceId => {
-      return await API.getPermissionForResource(resourceId)
-    },
-    getDependantsInfo: async resourceId => {
-      return await API.getDependants(resourceId)
-    },
-  }
-}
-
-export const permissions = createPermissionStore()

packages/builder/src/stores/builder/permissions.ts

@@ -0,0 +1,50 @@
+import { BudiStore } from "../BudiStore"
+import { API } from "@/api"
+import {
+  PermissionLevel,
+  GetResourcePermsResponse,
+  GetDependantResourcesResponse,
+  ResourcePermissionInfo,
+} from "@budibase/types"
+
+interface Permission {
+  level: PermissionLevel
+  role: string
+  resource: string
+}
+
+export class PermissionStore extends BudiStore<Permission[]> {
+  constructor() {
+    super([])
+  }
+
+  save = async (permission: Permission) => {
+    const { level, role, resource } = permission
+    return await API.updatePermissionForResource(resource, role, level)
+  }
+
+  remove = async (permission: Permission) => {
+    const { level, role, resource } = permission
+    return await API.removePermissionFromResource(resource, role, level)
+  }
+
+  forResource = async (
+    resourceId: string
+  ): Promise<Record<string, ResourcePermissionInfo>> => {
+    return (await API.getPermissionForResource(resourceId)).permissions
+  }
+
+  forResourceDetailed = async (
+    resourceId: string
+  ): Promise<GetResourcePermsResponse> => {
+    return await API.getPermissionForResource(resourceId)
+  }
+
+  getDependantsInfo = async (
+    resourceId: string
+  ): Promise<GetDependantResourcesResponse> => {
+    return await API.getDependants(resourceId)
+  }
+}
+
+export const permissions = new PermissionStore()

packages/builder/src/stores/builder/views.js

@@ -1,67 +0,0 @@
-import { writable, derived } from "svelte/store"
-import { tables } from "./tables"
-import { API } from "@/api"
-
-export function createViewsStore() {
-  const store = writable({
-    selectedViewName: null,
-  })
-  const derivedStore = derived([store, tables], ([$store, $tables]) => {
-    let list = []
-    $tables.list?.forEach(table => {
-      const views = Object.values(table?.views || {}).filter(view => {
-        return view.version !== 2
-      })
-      list = list.concat(views)
-    })
-    return {
-      ...$store,
-      list,
-      selected: list.find(view => view.name === $store.selectedViewName),
-    }
-  })
-
-  const select = name => {
-    store.update(state => ({
-      ...state,
-      selectedViewName: name,
-    }))
-  }
-
-  const deleteView = async view => {
-    await API.deleteView(view.name)
-
-    // Update tables
-    tables.update(state => {
-      const table = state.list.find(table => table._id === view.tableId)
-      delete table.views[view.name]
-      return { ...state }
-    })
-  }
-
-  const save = async view => {
-    const savedView = await API.saveView(view)
-    select(view.name)
-
-    // Update tables
-    tables.update(state => {
-      const table = state.list.find(table => table._id === view.tableId)
-      if (table) {
-        if (view.originalName) {
-          delete table.views[view.originalName]
-        }
-        table.views[view.name] = savedView
-      }
-      return { ...state }
-    })
-  }
-
-  return {
-    subscribe: derivedStore.subscribe,
-    select,
-    delete: deleteView,
-    save,
-  }
-}
-
-export const views = createViewsStore()

packages/builder/src/stores/builder/views.ts

@@ -0,0 +1,94 @@
+import { DerivedBudiStore } from "../BudiStore"
+import { tables } from "./tables"
+import { API } from "@/api"
+import { View } from "@budibase/types"
+import { helpers } from "@budibase/shared-core"
+import { derived, Writable } from "svelte/store"
+
+interface BuilderViewStore {
+  selectedViewName: string | null
+}
+
+interface DerivedViewStore extends BuilderViewStore {
+  list: View[]
+  selected?: View
+}
+
+export class ViewsStore extends DerivedBudiStore<
+  BuilderViewStore,
+  DerivedViewStore
+> {
+  constructor() {
+    const makeDerivedStore = (store: Writable<BuilderViewStore>) => {
+      return derived([store, tables], ([$store, $tables]): DerivedViewStore => {
+        let list: View[] = []
+        $tables.list?.forEach(table => {
+          const views = Object.values(table?.views || {}).filter(
+            (view): view is View => !helpers.views.isV2(view)
+          )
+          list = list.concat(views)
+        })
+        return {
+          selectedViewName: $store.selectedViewName,
+          list,
+          selected: list.find(view => view.name === $store.selectedViewName),
+        }
+      })
+    }
+
+    super(
+      {
+        selectedViewName: null,
+      },
+      makeDerivedStore
+    )
+
+    this.select = this.select.bind(this)
+  }
+
+  select = (name: string) => {
+    this.store.update(state => ({
+      ...state,
+      selectedViewName: name,
+    }))
+  }
+
+  delete = async (view: View) => {
+    if (!view.name) {
+      throw new Error("View name is required")
+    }
+    await API.deleteView(view.name)
+
+    // Update tables
+    tables.update(state => {
+      const table = state.list.find(table => table._id === view.tableId)
+      if (table?.views && view.name) {
+        delete table.views[view.name]
+      }
+      return { ...state }
+    })
+  }
+
+  save = async (view: View & { originalName?: string }) => {
+    if (!view.name) {
+      throw new Error("View name is required")
+    }
+
+    const savedView = await API.saveView(view)
+    this.select(view.name)
+
+    // Update tables
+    tables.update(state => {
+      const table = state.list.find(table => table._id === view.tableId)
+      if (table?.views && view.name) {
+        if (view.originalName) {
+          delete table.views[view.originalName]
+        }
+        table.views[view.name] = savedView
+      }
+      return { ...state }
+    })
+  }
+}
+
+export const views = new ViewsStore()