@budibase/server/src/tests/utilities/api/screen.ts

Budibase Web Server

import { Screen, UsageInScreensResponse } from "@budibase/types"
import { Expectations, TestAPI } from "./base"
import { TEST_WORKSPACEAPPID_PLACEHOLDER } from "../structures"

export class ScreenAPI extends TestAPI {
  list = async (expectations?: Expectations): Promise<Screen[]> => {
    return await this._get<Screen[]>(`/api/screens`, { expectations })
  }

  save = async (
    screen: Screen,
    expectations?: Expectations
  ): Promise<Screen> => {
    if (screen.workspaceAppId === TEST_WORKSPACEAPPID_PLACEHOLDER) {
      screen.workspaceAppId = this.config.getDefaultWorkspaceAppId()
    }

    return await this._post<Screen>(`/api/screens`, {
      expectations,
      body: screen,
    })
  }

  destroy = async (
    screenId: string,
    screenRev: string,
    expectations?: Expectations
  ): Promise<{ message: string }> => {
    return this._delete<{ message: string }>(
      `/api/screens/${screenId}/${screenRev}`,
      {
        expectations,
      }
    )
  }

  usage = async (
    sourceId: string,
    expectations?: Expectations
  ): Promise<UsageInScreensResponse> => {
    return this._post<UsageInScreensResponse>(
      `/api/screens/usage/${sourceId}`,
      {
        expectations,
      }
    )
  }
}