budibase/packages/builder/src/components/start/ExportAppModal.svelte

<script>
  import {
    ModalContent,
    keepOpen,
    Toggle,
    Body,
    InlineAlert,
    Input,
    notifications,
  } from "@budibase/bbui"
  import { downloadFile } from "@budibase/frontend-core"
  import { createValidationStore } from "helpers/validation/yup"

  export let app
  export let published
  let includeInternalTablesRows = true
  let encrypt = true

  let password = null
  const validation = createValidationStore()
  validation.addValidatorType("password", "password", true, { minLength: 8 })
  $: validation.observe("password", password)

  const Step = { CONFIG: "config", SET_PASSWORD: "set_password" }
  let currentStep = Step.CONFIG

  $: exportButtonText = published ? "Export published" : "Export latest"
  $: stepConfig = {
    [Step.CONFIG]: {
      title: published ? "Export published app" : "Export latest app",
      confirmText: encrypt ? "Continue" : exportButtonText,
      onConfirm: () => {
        if (!encrypt) {
          exportApp()
        } else {
          currentStep = Step.SET_PASSWORD
          return keepOpen
        }
      },
      isValid: true,
    },
    [Step.SET_PASSWORD]: {
      title: "Add password to encrypt your export",
      confirmText: exportButtonText,
      onConfirm: async () => {
        await validation.check({ password })
        if (!$validation.valid) {
          return keepOpen
        }
        await exportApp(password)
      },
      isValid: $validation.valid,
    },
  }

  const exportApp = async () => {
    const id = published ? app.prodId : app.devId
    const url = `/api/backups/export?appId=${id}`

    try {
      const downloaded = await downloadFile(url, {
        excludeRows: !includeInternalTablesRows,
        encryptPassword: password,
      })
      if (!downloaded) {
        notifications.error("Error exporting the app.")
      }
    } catch (error) {
      notifications.error(error.message || "Error downloading the exported app")
    }
  }
</script>

<ModalContent
  title={stepConfig[currentStep].title}
  confirmText={stepConfig[currentStep].confirmText}
  onConfirm={stepConfig[currentStep].onConfirm}
  disabled={!stepConfig[currentStep].isValid}
>
  {#if currentStep === Step.CONFIG}
    <Body>
      <Toggle
        text="Export rows from internal tables"
        bind:value={includeInternalTablesRows}
      />
      <Toggle text="Encrypt my export" bind:value={encrypt} />
    </Body>
    <InlineAlert
      header={encrypt
        ? "Please note Budibase does not encrypt attachments during the export process to ensure efficient export of large attachments."
        : "Do not share your Budibase application exports publicly as they may contain sensitive information such as database credentials or secret keys."}
    />
  {/if}
  {#if currentStep === Step.SET_PASSWORD}
    <Input
      type="password"
      label="Password"
      autocomplete="new-password"
      placeholder="Type here..."
      bind:value={password}
      error={$validation.errors.password}
    />
  {/if}
</ModalContent>
Export app without rows 2022-05-25 20:26:10 +12:00			`<script>`
Change the download to be a post 2023-06-14 21:47:46 +12:00			`import {`
			`ModalContent,`
Use constant for keeping modal open (#11067) 2023-07-06 00:49:39 +12:00			`keepOpen,`
Change the download to be a post 2023-06-14 21:47:46 +12:00			`Toggle,`
			`Body,`
			`InlineAlert,`
Add password field 2023-06-13 22:21:54 +12:00			`Input,`
Change the download to be a post 2023-06-14 21:47:46 +12:00			`notifications,`
			`} from "@budibase/bbui"`
Move downloadfile to frontend-core 2024-03-22 23:34:05 +13:00			`import { downloadFile } from "@budibase/frontend-core"`
Add validation 2023-06-13 22:57:56 +12:00			`import { createValidationStore } from "helpers/validation/yup"`
Export app without rows 2022-05-25 20:26:10 +12:00
			`export let app`
Fixing an issue with deleting large apps with a lot of internal table data and adding back the export modal which allows picking whether an export includes internal table rows - #7583. 2022-09-10 07:06:29 +12:00			`export let published`
Add encrypt option 2023-06-13 21:00:01 +12:00			`let includeInternalTablesRows = true`
Adding a check to make sure that encryption does not execute upon directories, as well as adding copy to warn that attachments are not encrypted. 2023-12-07 05:38:03 +13:00			`let encrypt = true`
Export app without rows 2022-05-25 20:26:10 +12:00
Validation observe 2023-06-13 23:42:30 +12:00			`let password = null`
Add validation 2023-06-13 22:57:56 +12:00			`const validation = createValidationStore()`
Do not rquire min length for all password fields 2023-06-20 01:53:02 +12:00			`validation.addValidatorType("password", "password", true, { minLength: 8 })`
Validation observe 2023-06-13 23:42:30 +12:00			`$: validation.observe("password", password)`
Export app without rows 2022-05-25 20:26:10 +12:00
Add steps 2023-06-13 22:15:32 +12:00			`const Step = { CONFIG: "config", SET_PASSWORD: "set_password" }`
Pass password 2023-06-13 23:45:57 +12:00			`let currentStep = Step.CONFIG`
Add steps 2023-06-13 22:15:32 +12:00
			`$: exportButtonText = published ? "Export published" : "Export latest"`
			`$: stepConfig = {`
			`[Step.CONFIG]: {`
			`title: published ? "Export published app" : "Export latest app",`
Adding a check to make sure that encryption does not execute upon directories, as well as adding copy to warn that attachments are not encrypted. 2023-12-07 05:38:03 +13:00			`confirmText: encrypt ? "Continue" : exportButtonText,`
Add steps 2023-06-13 22:15:32 +12:00			`onConfirm: () => {`
Adding a check to make sure that encryption does not execute upon directories, as well as adding copy to warn that attachments are not encrypted. 2023-12-07 05:38:03 +13:00			`if (!encrypt) {`
Add steps 2023-06-13 22:15:32 +12:00			`exportApp()`
			`} else {`
			`currentStep = Step.SET_PASSWORD`
Use constant for keeping modal open (#11067) 2023-07-06 00:49:39 +12:00			`return keepOpen`
Add steps 2023-06-13 22:15:32 +12:00			`}`
			`},`
Validation observe 2023-06-13 23:42:30 +12:00			`isValid: true,`
Add steps 2023-06-13 22:15:32 +12:00			`},`
			`[Step.SET_PASSWORD]: {`
			`title: "Add password to encrypt your export",`
			`confirmText: exportButtonText,`
Add validation 2023-06-13 22:57:56 +12:00			`onConfirm: async () => {`
Validation observe 2023-06-13 23:42:30 +12:00			`await validation.check({ password })`
Add validation 2023-06-13 22:57:56 +12:00			`if (!$validation.valid) {`
Use constant for keeping modal open (#11067) 2023-07-06 00:49:39 +12:00			`return keepOpen`
Add password field 2023-06-13 22:21:54 +12:00			`}`
Getting export modal to wait. 2023-12-06 05:10:01 +13:00			`await exportApp(password)`
Add steps 2023-06-13 22:15:32 +12:00			`},`
Validation observe 2023-06-13 23:42:30 +12:00			`isValid: $validation.valid,`
Add steps 2023-06-13 22:15:32 +12:00			`},`
			`}`
Fixing an issue with deleting large apps with a lot of internal table data and adding back the export modal which allows picking whether an export includes internal table rows - #7583. 2022-09-10 07:06:29 +12:00
Change the download to be a post 2023-06-14 21:47:46 +12:00			`const exportApp = async () => {`
Fixing an issue with deleting large apps with a lot of internal table data and adding back the export modal which allows picking whether an export includes internal table rows - #7583. 2022-09-10 07:06:29 +12:00			`const id = published ? app.prodId : app.devId`
Remove excludeRows and appName from the querystrings 2023-06-14 22:06:46 +12:00			const url = `/api/backups/export?appId=${id}`
Remove notifications from frontend-core 2024-03-22 23:40:27 +13:00
Change the download to be a post 2023-06-14 21:47:46 +12:00			`try {`
Remove notifications from frontend-core 2024-03-22 23:40:27 +13:00			`const downloaded = await downloadFile(url, {`
Move downloadfile to frontend-core 2024-03-22 23:34:05 +13:00			`excludeRows: !includeInternalTablesRows,`
			`encryptPassword: password,`
Change the download to be a post 2023-06-14 21:47:46 +12:00			`})`
Remove notifications from frontend-core 2024-03-22 23:40:27 +13:00			`if (!downloaded) {`
			`notifications.error("Error exporting the app.")`
			`}`
Change the download to be a post 2023-06-14 21:47:46 +12:00			`} catch (error) {`
Simplify notification 2023-06-15 00:48:37 +12:00			`notifications.error(error.message \|\| "Error downloading the exported app")`
Change the download to be a post 2023-06-14 21:47:46 +12:00			`}`
Export app without rows 2022-05-25 20:26:10 +12:00			`}`
			`</script>`

Add steps 2023-06-13 22:15:32 +12:00			`<ModalContent`
			`title={stepConfig[currentStep].title}`
			`confirmText={stepConfig[currentStep].confirmText}`
			`onConfirm={stepConfig[currentStep].onConfirm}`
Validation observe 2023-06-13 23:42:30 +12:00			`disabled={!stepConfig[currentStep].isValid}`
Add steps 2023-06-13 22:15:32 +12:00			`>`
Add password field 2023-06-13 22:21:54 +12:00			`{#if currentStep === Step.CONFIG}`
Add validation 2023-06-13 22:57:56 +12:00			`<Body>`
			`<Toggle`
			`text="Export rows from internal tables"`
			`bind:value={includeInternalTablesRows}`
			`/>`
Adding a check to make sure that encryption does not execute upon directories, as well as adding copy to warn that attachments are not encrypted. 2023-12-07 05:38:03 +13:00			`<Toggle text="Encrypt my export" bind:value={encrypt} />`
Add validation 2023-06-13 22:57:56 +12:00			`</Body>`
Adding a check to make sure that encryption does not execute upon directories, as well as adding copy to warn that attachments are not encrypted. 2023-12-07 05:38:03 +13:00			`<InlineAlert`
			`header={encrypt`
Removing errant the. 2023-12-07 05:41:44 +13:00			`? "Please note Budibase does not encrypt attachments during the export process to ensure efficient export of large attachments."`
Adding a check to make sure that encryption does not execute upon directories, as well as adding copy to warn that attachments are not encrypted. 2023-12-07 05:38:03 +13:00			`: "Do not share your Budibase application exports publicly as they may contain sensitive information such as database credentials or secret keys."}`
			`/>`
Add password field 2023-06-13 22:21:54 +12:00			`{/if}`
			`{#if currentStep === Step.SET_PASSWORD}`
			`<Input`
Add validation 2023-06-13 22:57:56 +12:00			`type="password"`
Add password field 2023-06-13 22:21:54 +12:00			`label="Password"`
Duplicate app behaviour and test updates 2024-02-23 04:00:16 +13:00			`autocomplete="new-password"`
Add password field 2023-06-13 22:21:54 +12:00			`placeholder="Type here..."`
			`bind:value={password}`
Add validation 2023-06-13 22:57:56 +12:00			`error={$validation.errors.password}`
Add encrypt option 2023-06-13 21:00:01 +12:00			`/>`
			`{/if}`
Export app without rows 2022-05-25 20:26:10 +12:00			`</ModalContent>`