Merge pull request #1989 from Budibase/fix/email-explanation
Email template descriptions/information
This commit is contained in:
Michael Drury
GitHub
commit
fd76e532c7
|
|
@ -16,6 +16,7 @@
|
|||
import Editor from "components/integration/QueryEditor.svelte"
|
||||
import TemplateBindings from "./_components/TemplateBindings.svelte"
|
||||
|
||||
// this is the email purpose
|
||||
export let template
|
||||
|
||||
let htmlEditor
|
||||
|
|
@ -24,9 +25,11 @@
|
|||
$: selectedTemplate = $email.templates?.find(
|
||||
({ purpose }) => purpose === template
|
||||
)
|
||||
$: name = $email.definitions?.info[template]?.name
|
||||
$: description = $email.definitions?.info[template]?.description
|
||||
$: baseTemplate = $email.templates?.find(({ purpose }) => purpose === "base")
|
||||
$: templateBindings =
|
||||
$email.definitions?.bindings?.[selectedTemplate.purpose] || []
|
||||
$email.definitions?.bindings?.[selectedTemplate?.purpose] || []
|
||||
$: previewContent = makePreviewContent(baseTemplate, selectedTemplate)
|
||||
|
||||
async function saveTemplate() {
|
||||
|
|
@ -81,10 +84,12 @@
|
|||
</div>
|
||||
<header>
|
||||
<Heading>
|
||||
Email Template: {template}
|
||||
Email Template: {name}
|
||||
</Heading>
|
||||
<Button cta on:click={saveTemplate}>Save</Button>
|
||||
</header>
|
||||
<Detail>Description</Detail>
|
||||
<Body>{description}</Body>
|
||||
<Body
|
||||
>Change the email template here. Add dynamic content by using the bindings
|
||||
menu on the right.</Body
|
||||
|
|
|
|||
|
|
@ -1,13 +0,0 @@
|
|||
<script>
|
||||
import { goto } from "@roxi/routify"
|
||||
|
||||
export let value
|
||||
</script>
|
||||
|
||||
<span on:click={() => $goto(`./${value}`)}>{value}</span>
|
||||
|
||||
<style>
|
||||
span {
|
||||
text-transform: capitalize;
|
||||
}
|
||||
</style>
|
||||
|
|
@ -14,7 +14,6 @@
|
|||
Checkbox,
|
||||
} from "@budibase/bbui"
|
||||
import { email } from "stores/portal"
|
||||
import TemplateLink from "./_components/TemplateLink.svelte"
|
||||
import api from "builderStore/api"
|
||||
import { cloneDeep } from "lodash/fp"
|
||||
|
||||
|
|
@ -23,23 +22,30 @@
|
|||
}
|
||||
|
||||
const templateSchema = {
|
||||
purpose: {
|
||||
displayName: "Email",
|
||||
name: {
|
||||
displayName: "Name",
|
||||
editable: false,
|
||||
},
|
||||
category: {
|
||||
displayName: "Category",
|
||||
editable: false,
|
||||
},
|
||||
}
|
||||
|
||||
const customRenderers = [
|
||||
{
|
||||
column: "purpose",
|
||||
component: TemplateLink,
|
||||
},
|
||||
]
|
||||
$: emailInfo = getEmailInfo($email.definitions)
|
||||
|
||||
let smtpConfig
|
||||
let loading
|
||||
let requireAuth = false
|
||||
|
||||
function getEmailInfo(definitions) {
|
||||
if (!definitions) {
|
||||
return []
|
||||
}
|
||||
const entries = Object.entries(definitions.info)
|
||||
return entries.map(([key, value]) => ({ purpose: key, ...value }))
|
||||
}
|
||||
|
||||
async function saveSmtp() {
|
||||
// clone it so we can remove stuff if required
|
||||
const smtp = cloneDeep(smtpConfig)
|
||||
|
|
@ -159,8 +165,7 @@
|
|||
</Body>
|
||||
</Layout>
|
||||
<Table
|
||||
{customRenderers}
|
||||
data={$email.templates}
|
||||
data={emailInfo}
|
||||
schema={templateSchema}
|
||||
{loading}
|
||||
on:click={({ detail }) => $goto(`./${detail.purpose}`)}
|
||||
|
|
|
|||
|
|
@ -28,12 +28,18 @@ exports.save = async ctx => {
|
|||
|
||||
exports.definitions = async ctx => {
|
||||
const bindings = {}
|
||||
|
||||
const info = {}
|
||||
for (let template of TemplateMetadata.email) {
|
||||
bindings[template.purpose] = template.bindings
|
||||
info[template.purpose] = {
|
||||
name: template.name,
|
||||
description: template.description,
|
||||
category: template.category,
|
||||
}
|
||||
}
|
||||
|
||||
ctx.body = {
|
||||
info,
|
||||
bindings: {
|
||||
...bindings,
|
||||
common: Object.values(TemplateBindings),
|
||||
|
|
|
|||
|
|
@ -96,7 +96,10 @@ const TemplateBindings = {
|
|||
const TemplateMetadata = {
|
||||
[TemplateTypes.EMAIL]: [
|
||||
{
|
||||
name: "Base Format",
|
||||
name: "Base format",
|
||||
description:
|
||||
"This is the base template, all others are based on it. The {{ body }} will be replaced with another email template.",
|
||||
category: "miscellaneous",
|
||||
purpose: EmailTemplatePurpose.BASE,
|
||||
bindings: [
|
||||
{
|
||||
|
|
@ -110,7 +113,10 @@ const TemplateMetadata = {
|
|||
],
|
||||
},
|
||||
{
|
||||
name: "Password Recovery",
|
||||
name: "Password recovery",
|
||||
description:
|
||||
"When a user requests a password reset they will receive an email built with this template.",
|
||||
category: "user management",
|
||||
purpose: EmailTemplatePurpose.PASSWORD_RECOVERY,
|
||||
bindings: [
|
||||
{
|
||||
|
|
@ -126,7 +132,18 @@ const TemplateMetadata = {
|
|||
],
|
||||
},
|
||||
{
|
||||
name: "New User Invitation",
|
||||
name: "User welcome",
|
||||
description:
|
||||
"When a new user is added they will be sent a welcome email using this template.",
|
||||
category: "user management",
|
||||
purpose: EmailTemplatePurpose.WELCOME,
|
||||
bindings: [],
|
||||
},
|
||||
{
|
||||
name: "User invitation",
|
||||
description:
|
||||
"When inviting a user via the email on-boarding this template will be used.",
|
||||
category: "user management",
|
||||
purpose: EmailTemplatePurpose.INVITATION,
|
||||
bindings: [
|
||||
{
|
||||
|
|
@ -143,6 +160,9 @@ const TemplateMetadata = {
|
|||
},
|
||||
{
|
||||
name: "Custom",
|
||||
description:
|
||||
"A custom template, this is currently used for SMTP email actions in automations.",
|
||||
category: "automations",
|
||||
purpose: EmailTemplatePurpose.CUSTOM,
|
||||
bindings: [
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in New Issue