# Pull Request Template ## Description This PR adds new eslint rules to the code base. **Error rules** | Rule name | Type | Files updated | | ----------------- | --- | - | | `vue/block-order` | error | ✅ | | `vue/component-name-in-template-casing` | error | ✅ | | `vue/component-options-name-casing` | error | ✅ | | `vue/custom-event-name-casing` | error | ✅ | | `vue/define-emits-declaration` | error | ✅ | | `vue/no-unused-properties` | error | ✅ | | `vue/define-macros-order` | error | ✅ | | `vue/define-props-declaration` | error | ✅ | | `vue/match-component-import-name` | error | ✅ | | `vue/next-tick-style` | error | ✅ | | `vue/no-bare-strings-in-template` | error | ✅ | | `vue/no-empty-component-block` | error | ✅ | | `vue/no-multiple-objects-in-class` | error | ✅ | | `vue/no-required-prop-with-default` | error | ✅ | | `vue/no-static-inline-styles` | error | ✅ | | `vue/no-template-target-blank` | error | ✅ | | `vue/no-this-in-before-route-enter` | error | ✅ | | `vue/no-undef-components` | error | ✅ | | `vue/no-unused-emit-declarations` | error | ✅ | | `vue/no-unused-refs` | error | ✅ | | `vue/no-use-v-else-with-v-for` | error | ✅ | | `vue/no-useless-v-bind` | error | ✅ | | `vue/no-v-text` | error | ✅ | | `vue/padding-line-between-blocks` | error | ✅ | | ~`vue/prefer-prop-type-boolean-first`~ | ~error~ | ❌ (removed this rule, cause a bug in displaying custom attributes) | | `vue/prefer-separate-static-class` | error | ✅ | | `vue/prefer-true-attribute-shorthand` | error | ✅ | | `vue/require-explicit-slots` | error | ✅ | | `vue/require-macro-variable-name` | error | ✅ | **Warn rules** | Rule name | Type | Files updated | | ---- | ------------- | ------------- | | `vue/no-root-v-if` | warn | ❎ | Fixes https://linear.app/chatwoot/issue/CW-3492/vue-eslint-rules ## Type of change - [x] New feature (non-breaking change which adds functionality) ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules --------- Co-authored-by: Fayaz Ahmed <fayazara@gmail.com> Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com> Co-authored-by: Shivam Mishra <scm.mymail@gmail.com> Co-authored-by: Pranav <pranav@chatwoot.com>
189 lines
4.6 KiB
Vue
189 lines
4.6 KiB
Vue
<script>
|
|
/**
|
|
* This component handles parsing and sending WhatsApp message templates.
|
|
* It works as follows:
|
|
* 1. Displays the template text with variable placeholders.
|
|
* 2. Generates input fields for each variable in the template.
|
|
* 3. Validates that all variables are filled before sending.
|
|
* 4. Replaces placeholders with user-provided values.
|
|
* 5. Emits events to send the processed message or reset the template.
|
|
*/
|
|
import { ref, computed, onMounted } from 'vue';
|
|
import { useVuelidate } from '@vuelidate/core';
|
|
import { requiredIf } from '@vuelidate/validators';
|
|
|
|
export default {
|
|
props: {
|
|
template: {
|
|
type: Object,
|
|
default: () => ({}),
|
|
},
|
|
},
|
|
setup(props, { emit }) {
|
|
const processVariable = str => {
|
|
return str.replace(/{{|}}/g, '');
|
|
};
|
|
|
|
const allKeysRequired = value => {
|
|
const keys = Object.keys(value);
|
|
return keys.every(key => value[key]);
|
|
};
|
|
|
|
const processedParams = ref({});
|
|
|
|
const templateString = computed(() => {
|
|
return props.template.components.find(
|
|
component => component.type === 'BODY'
|
|
).text;
|
|
});
|
|
|
|
const variables = computed(() => {
|
|
return templateString.value.match(/{{([^}]+)}}/g);
|
|
});
|
|
|
|
const processedString = computed(() => {
|
|
return templateString.value.replace(/{{([^}]+)}}/g, (match, variable) => {
|
|
const variableKey = processVariable(variable);
|
|
return processedParams.value[variableKey] || `{{${variable}}}`;
|
|
});
|
|
});
|
|
|
|
const v$ = useVuelidate(
|
|
{
|
|
processedParams: {
|
|
requiredIfKeysPresent: requiredIf(variables),
|
|
allKeysRequired,
|
|
},
|
|
},
|
|
{ processedParams }
|
|
);
|
|
|
|
const generateVariables = () => {
|
|
const matchedVariables = templateString.value.match(/{{([^}]+)}}/g);
|
|
if (!matchedVariables) return;
|
|
|
|
const finalVars = matchedVariables.map(i => processVariable(i));
|
|
processedParams.value = finalVars.reduce((acc, variable) => {
|
|
acc[variable] = '';
|
|
return acc;
|
|
}, {});
|
|
};
|
|
|
|
const resetTemplate = () => {
|
|
emit('resetTemplate');
|
|
};
|
|
|
|
const sendMessage = () => {
|
|
v$.value.$touch();
|
|
if (v$.value.$invalid) return;
|
|
|
|
const payload = {
|
|
message: processedString.value,
|
|
templateParams: {
|
|
name: props.template.name,
|
|
category: props.template.category,
|
|
language: props.template.language,
|
|
namespace: props.template.namespace,
|
|
processed_params: processedParams.value,
|
|
},
|
|
};
|
|
emit('sendMessage', payload);
|
|
};
|
|
|
|
onMounted(generateVariables);
|
|
|
|
return {
|
|
processedParams,
|
|
variables,
|
|
templateString,
|
|
processedString,
|
|
v$,
|
|
resetTemplate,
|
|
sendMessage,
|
|
};
|
|
},
|
|
};
|
|
</script>
|
|
|
|
<template>
|
|
<div class="w-full">
|
|
<textarea
|
|
v-model="processedString"
|
|
rows="4"
|
|
readonly
|
|
class="template-input"
|
|
/>
|
|
<div v-if="variables" class="template__variables-container">
|
|
<p class="variables-label">
|
|
{{ $t('WHATSAPP_TEMPLATES.PARSER.VARIABLES_LABEL') }}
|
|
</p>
|
|
<div
|
|
v-for="(variable, key) in processedParams"
|
|
:key="key"
|
|
class="template__variable-item"
|
|
>
|
|
<span class="variable-label">
|
|
{{ key }}
|
|
</span>
|
|
<woot-input
|
|
v-model="processedParams[key]"
|
|
type="text"
|
|
class="variable-input"
|
|
:styles="{ marginBottom: 0 }"
|
|
/>
|
|
</div>
|
|
<p v-if="v$.$dirty && v$.$invalid" class="error">
|
|
{{ $t('WHATSAPP_TEMPLATES.PARSER.FORM_ERROR_MESSAGE') }}
|
|
</p>
|
|
</div>
|
|
<footer>
|
|
<woot-button variant="smooth" @click="resetTemplate">
|
|
{{ $t('WHATSAPP_TEMPLATES.PARSER.GO_BACK_LABEL') }}
|
|
</woot-button>
|
|
<woot-button type="button" @click="sendMessage">
|
|
{{ $t('WHATSAPP_TEMPLATES.PARSER.SEND_MESSAGE_LABEL') }}
|
|
</woot-button>
|
|
</footer>
|
|
</div>
|
|
</template>
|
|
|
|
<style scoped lang="scss">
|
|
.template__variables-container {
|
|
@apply p-2.5;
|
|
}
|
|
|
|
.variables-label {
|
|
@apply text-sm font-semibold mb-2.5;
|
|
}
|
|
|
|
.template__variable-item {
|
|
@apply items-center flex mb-2.5;
|
|
|
|
.label {
|
|
@apply text-xs;
|
|
}
|
|
|
|
.variable-input {
|
|
@apply flex-1 text-sm ml-2.5;
|
|
}
|
|
|
|
.variable-label {
|
|
@apply bg-slate-75 dark:bg-slate-700 text-slate-700 dark:text-slate-100 inline-block rounded-md text-xs py-2.5 px-6;
|
|
}
|
|
}
|
|
|
|
footer {
|
|
@apply flex justify-end;
|
|
|
|
button {
|
|
@apply ml-2.5;
|
|
}
|
|
}
|
|
.error {
|
|
@apply bg-red-100 dark:bg-red-100 rounded-md text-red-800 dark:text-red-800 p-2.5 text-center;
|
|
}
|
|
.template-input {
|
|
@apply bg-slate-25 dark:bg-slate-900 text-slate-700 dark:text-slate-100;
|
|
}
|
|
</style>
|