@budibase/server/src/sdk/app/navigation/index.ts

Budibase Web Server

import { context, HTTPError } from "@budibase/backend-core"
import sdk from "../.."
import { App, AppNavigation } from "@budibase/types"

export async function addLink({
  label,
  url,
  roleId,
  workspaceAppId,
}: {
  label: string
  url: string
  roleId: string
  workspaceAppId: string
}) {
  const workspaceApp = await sdk.workspaceApps.get(workspaceAppId)
  if (!workspaceApp) {
    throw new HTTPError("Workspace app should be defined", 500)
  }
  workspaceApp.navigation.links ??= []
  workspaceApp.navigation.links.push({
    text: label,
    url,
    roleId,
    type: "link",
  })

  await sdk.workspaceApps.update(workspaceApp)

  if (workspaceApp.isDefault) {
    // TODO: remove when cleaning the flag FeatureFlag.WORKSPACE_APPS
    const appMetadata = await sdk.applications.metadata.get()
    appMetadata.navigation ??= {
      navigation: "Top",
    }
    appMetadata.navigation.links ??= []
    appMetadata.navigation.links.push({
      text: label,
      url,
      roleId,
      type: "link",
    })

    const db = context.getAppDB()
    await db.put(appMetadata)
  }
}

export async function deleteLink(route: string, workspaceAppId: string) {
  const workspaceApp = (await sdk.workspaceApps.get(workspaceAppId!))!
  workspaceApp.navigation.links ??= []

  // Filter out top level links pointing to these URLs
  const updatedLinks = workspaceApp.navigation.links.filter(
    link => link.url !== route
  )

  // Filter out nested links pointing to these URLs
  updatedLinks.forEach(link => {
    if (link.type === "sublinks" && link.subLinks?.length) {
      link.subLinks = link.subLinks.filter(subLink => subLink.url !== route)
    }
  })

  await sdk.workspaceApps.update({
    ...workspaceApp,
    navigation: { ...workspaceApp.navigation, links: updatedLinks },
  })

  if (workspaceApp.isDefault) {
    // TODO: remove when cleaning the flag FeatureFlag.WORKSPACE_APPS
    const appMetadata = await sdk.applications.metadata.get()
    const navigation = appMetadata.navigation
    if (!navigation || !navigation.links?.length) {
      return
    }

    // Filter out top level links pointing to these URLs
    const updatedLinks = navigation.links.filter(link => link.url !== route)

    // Filter out nested links pointing to these URLs
    updatedLinks.forEach(link => {
      if (link.type === "sublinks" && link.subLinks?.length) {
        link.subLinks = link.subLinks.filter(subLink => subLink.url !== route)
      }
    })

    const db = context.getAppDB()
    const updatedMetadata: App = {
      ...appMetadata,
      navigation: {
        ...navigation,
        links: updatedLinks,
      },
    }
    await db.put(updatedMetadata)
  }
}

export async function update(
  workspaceAppId: string,
  navigation: AppNavigation
) {
  const workspaceApp = await sdk.workspaceApps.get(workspaceAppId)
  if (!workspaceApp) {
    throw new HTTPError("Workspace app not found", 400)
  }
  await sdk.workspaceApps.update({ ...workspaceApp, navigation })

  if (workspaceApp.isDefault) {
    const appMetadata = await sdk.applications.metadata.get()
    appMetadata.navigation = navigation

    const db = context.getAppDB()
    await db.put(appMetadata)
  }
}