nocodb/packages/nc-gui/components/webhook/Editor.vue

<script setup lang="ts">
import { Form, message } from 'ant-design-vue'
import type { Ref } from 'vue'
import type { AuditType } from 'nocodb-sdk'
import {
  MetaInj,
  extractSdkResponseErrorMsg,
  fieldRequiredValidator,
  inject,
  reactive,
  useApi,
  useI18n,
  useNuxtApp,
} from '#imports'

const emit = defineEmits(['backToList', 'editOrAdd'])

const { t } = useI18n()

const { $e } = useNuxtApp()

const { api, isLoading: loading } = useApi()

const meta = inject(MetaInj, ref())

const useForm = Form.useForm

const hook = reactive<Record<string, any>>({
  id: '',
  title: '',
  event: '',
  operation: '',
  eventOperation: '',
  notification: {
    type: 'URL',
    payload: {
      method: 'POST',
      body: '{{ json data }}',
      headers: [{}],
      parameters: [{}],
    },
  },
  condition: false,
})

const urlTabKey = ref('body')

const apps: Record<string, any> = ref()

const webhookTestRef = ref()

const slackChannels = ref<Record<string, any>[]>([])

const teamsChannels = ref<Record<string, any>[]>([])

const discordChannels = ref<Record<string, any>[]>([])

const mattermostChannels = ref<Record<string, any>[]>([])

const filterRef = ref()

const formInput = ref({
  'Email': [
    {
      key: 'to',
      label: 'To Address',
      placeholder: 'To Address',
      type: 'SingleLineText',
      required: true,
    },
    {
      key: 'subject',
      label: 'Subject',
      placeholder: 'Subject',
      type: 'SingleLineText',
      required: true,
    },
    {
      key: 'body',
      label: 'Body',
      placeholder: 'Body',
      type: 'LongText',
      required: true,
    },
  ],
  'Slack': [
    {
      key: 'body',
      label: 'Body',
      placeholder: 'Body',
      type: 'LongText',
      required: true,
    },
  ],
  'Microsoft Teams': [
    {
      key: 'body',
      label: 'Body',
      placeholder: 'Body',
      type: 'LongText',
      required: true,
    },
  ],
  'Discord': [
    {
      key: 'body',
      label: 'Body',
      placeholder: 'Body',
      type: 'LongText',
      required: true,
    },
  ],
  'Mattermost': [
    {
      key: 'body',
      label: 'Body',
      placeholder: 'Body',
      type: 'LongText',
      required: true,
    },
  ],
  'Twilio': [
    {
      key: 'body',
      label: 'Body',
      placeholder: 'Body',
      type: 'LongText',
      required: true,
    },
    {
      key: 'to',
      label: 'Comma separated Mobile #',
      placeholder: 'Comma separated Mobile #',
      type: 'LongText',
      required: true,
    },
  ],
  'Whatsapp Twilio': [
    {
      key: 'body',
      label: 'Body',
      placeholder: 'Body',
      type: 'LongText',
      required: true,
    },
    {
      key: 'to',
      label: 'Comma separated Mobile #',
      placeholder: 'Comma separated Mobile #',
      type: 'LongText',
      required: true,
    },
  ],
})

const eventList = ref([
  // {text: ["Before", "Insert"], value: ['before', 'insert']},
  { text: ['After', 'Insert'], value: ['after', 'insert'] },
  // {text: ["Before", "Update"], value: ['before', 'update']},
  { text: ['After', 'Update'], value: ['after', 'update'] },
  // {text: ["Before", "Delete"], value: ['before', 'delete']},
  { text: ['After', 'Delete'], value: ['after', 'delete'] },
])

const notificationList = ref([
  { type: 'URL' },
  { type: 'Email' },
  { type: 'Slack' },
  { type: 'Microsoft Teams' },
  { type: 'Discord' },
  { type: 'Mattermost' },
  { type: 'Twilio' },
  { type: 'Whatsapp Twilio' },
])

const methodList = ref([
  { title: 'GET' },
  { title: 'POST' },
  { title: 'DELETE' },
  { title: 'PUT' },
  { title: 'HEAD' },
  { title: 'PATCH' },
])

const validators = computed(() => {
  return {
    'title': [fieldRequiredValidator()],
    'eventOperation': [fieldRequiredValidator()],
    'notification.type': [fieldRequiredValidator()],
    ...(hook.notification.type === 'URL' && {
      'notification.payload.method': [fieldRequiredValidator()],
      'notification.payload.path': [fieldRequiredValidator()],
    }),
    ...(hook.notification.type === 'Email' && {
      'notification.payload.to': [fieldRequiredValidator()],
      'notification.payload.subject': [fieldRequiredValidator()],
      'notification.payload.body': [fieldRequiredValidator()],
    }),
    ...((hook.notification.type === 'Slack' ||
      hook.notification.type === 'Microsoft Teams' ||
      hook.notification.type === 'Discord' ||
      hook.notification.type === 'Mattermost') && {
      'notification.payload.channels': [fieldRequiredValidator()],
      'notification.payload.body': [fieldRequiredValidator()],
    }),
    ...((hook.notification.type === 'Twilio' || hook.notification.type === 'Whatsapp Twilio') && {
      'notification.payload.body': [fieldRequiredValidator()],
      'notification.payload.to': [fieldRequiredValidator()],
    }),
  }
})
const { validate, validateInfos } = useForm(hook, validators)

function onNotTypeChange(reset = false) {
  if (reset) {
    hook.notification.payload = {} as Record<string, any>
  }

  if (hook.notification.type === 'Slack') {
    slackChannels.value = (apps.value && apps.value.Slack && apps.Slack.parsedInput) || []
  }

  if (hook.notification.type === 'Microsoft Teams') {
    teamsChannels.value = (apps.value && apps.value['Microsoft Teams'] && apps.value['Microsoft Teams'].parsedInput) || []
  }

  if (hook.notification.type === 'Discord') {
    discordChannels.value = (apps.value && apps.value.Discord && apps.value.Discord.parsedInput) || []
  }

  if (hook.notification.type === 'Mattermost') {
    mattermostChannels.value = (apps.value && apps.value.Mattermost && apps.value.Mattermost.parsedInput) || []
  }

  if (hook.notification.type === 'URL') {
    hook.notification.payload.body = hook.notification.payload.body || '{{ json data }}'
    hook.notification.payload.parameters = hook.notification.payload.parameters || [{}]
    hook.notification.payload.headers = hook.notification.payload.headers || [{}]
    hook.notification.payload.method = hook.notification.payload.method || 'POST'
    hook.notification.payload.auth = hook.notification.payload.auth || ''
  }
}

function setHook(newHook: any) {
  Object.assign(hook, {
    ...newHook,
    notification: {
      ...newHook.notification,
      payload: newHook.notification.payload,
    },
  })
}

async function onEventChange() {
  const { notification: { payload = {}, type = {} } = {} } = hook

  Object.assign(hook, {
    ...hook,
    notification: {
      type,
      payload,
    },
  })

  hook.notification.payload = payload

  let channels: Ref<Record<string, any>[] | null> = ref(null)

  switch (hook.notification.type) {
    case 'Slack':
      channels = slackChannels
      break
    case 'Microsoft Teams':
      channels = teamsChannels
      break
    case 'Discord':
      channels = discordChannels
      break
    case 'Mattermost':
      channels = mattermostChannels
      break
  }

  if (channels) {
    hook.notification.payload.webhook_url =
      hook.notification.payload.webhook_url &&
      hook.notification.payload.webhook_url.map((v: { webhook_url: string }) =>
        channels.value?.find((s) => v.webhook_url === s.webhook_url),
      )
  }

  if (hook.notification.type === 'URL') {
    hook.notification.payload = hook.notification.payload || {}
    hook.notification.payload.parameters = hook.notification.payload.parameters || [{}]
    hook.notification.payload.headers = hook.notification.payload.headers || [{}]
    hook.notification.payload.method = hook.notification.payload.method || 'POST'
  }
}

async function loadPluginList() {
  try {
    const plugins = (await api.plugin.list()).list!

    apps.value = plugins.reduce((o, p) => {
      const plugin: { title: string; tags: string[]; parsedInput: Record<string, any> } = {
        title: '',
        tags: [],
        parsedInput: {},
        ...(p as any),
      }
      plugin.tags = p.tags ? p.tags.split(',') : []
      plugin.parsedInput = p.input && JSON.parse(p.input)
      o[plugin.title] = plugin

      return o
    }, {} as Record<string, any>)

    if (hook.event && hook.operation) {
      hook.eventOperation = `${hook.event} ${hook.operation}`
    }

    onNotTypeChange()
  } catch (e: any) {
    message.error(await extractSdkResponseErrorMsg(e))
  }
}

async function saveHooks() {
  loading.value = true
  try {
    await validate()
  } catch (_: any) {
    message.error(t('msg.error.invalidForm'))

    loading.value = false

    return
  }

  try {
    let res
    if (hook.id) {
      res = await api.dbTableWebhook.update(hook.id, {
        ...hook,
        notification: {
          ...hook.notification,
          payload: hook.notification.payload,
        },
      })
    } else {
      res = await api.dbTableWebhook.create(meta.value!.id!, {
        ...hook,
        notification: {
          ...hook.notification,
          payload: hook.notification.payload,
        },
      } as AuditType)
    }

    if (!hook.id && res) {
      hook.id = res.id
    }

    if (filterRef.value) {
      await filterRef.value.applyChanges(hook.id)
    }

    // Webhook details updated successfully
    message.success(t('msg.success.webhookUpdated'))
  } catch (e: any) {
    message.error(await extractSdkResponseErrorMsg(e))
  } finally {
    loading.value = false
  }

  $e('a:webhook:add', {
    operation: hook.operation,
    condition: hook.condition,
    notification: hook.notification.type,
  })
}

async function testWebhook() {
  await webhookTestRef.value.testWebhook()
}

defineExpose({
  onEventChange,
  setHook,
})

watch(
  () => hook.eventOperation,
  () => {
    if (!hook.eventOperation) return

    const [event, operation] = hook.eventOperation.split(' ')
    hook.event = event
    hook.operation = operation
  },
)

onMounted(async () => {
  await loadPluginList()
})
</script>

<template>
  <div class="flex">
    <div class="flex-1">
      <div class="flex items-center mt-2">
        <MdiArrowLeftBold class="mr-3 text-xl cursor-pointer nc-icon-hook-navigate-left" @click="emit('backToList')" />
        <span class="inline text-xl font-bold">{{ meta.title }} : {{ hook.title || 'Webhooks' }} </span>
      </div>
    </div>
    <div>
      <a-button class="mr-3 nc-btn-webhook-test" size="large" @click="testWebhook">
        <div class="flex items-center">
          <MdiGestureDoubleTap class="mr-2" />
          <!-- TODO: i18n -->
          Test Webhook
        </div>
      </a-button>
      <a-button class="nc-btn-webhook-save" type="primary" size="large" @click.prevent="saveHooks">
        <div class="flex items-center">
          <MdiContentSave class="mr-2" />
          <!-- Save -->
          {{ $t('general.save') }}
        </div>
      </a-button>
    </div>
  </div>
  <a-divider />
  <a-form :model="hook" name="create-or-edit-webhook">
    <a-form-item>
      <a-row type="flex">
        <a-col :span="24">
          <a-form-item v-bind="validateInfos.title">
            <a-input
              v-model:value="hook.title"
              size="large"
              :placeholder="$t('general.title')"
              class="nc-text-field-hook-title"
            />
          </a-form-item>
        </a-col>
      </a-row>
      <a-row type="flex" :gutter="[16, 16]">
        <a-col :span="12">
          <a-form-item v-bind="validateInfos.eventOperation">
            <a-select
              v-model:value="hook.eventOperation"
              size="large"
              :placeholder="$t('general.event')"
              class="nc-text-field-hook-event"
              dropdown-class-name="nc-dropdown-webhook-event"
            >
              <a-select-option v-for="(event, i) in eventList" :key="i" :value="event.value.join(' ')">
                {{ event.text.join(' ') }}
              </a-select-option>
            </a-select>
          </a-form-item>
        </a-col>
        <a-col :span="12">
          <a-form-item v-bind="validateInfos['notification.type']">
            <a-select
              v-model:value="hook.notification.type"
              size="large"
              class="nc-select-hook-notification-type"
              :placeholder="$t('general.notification')"
              dropdown-class-name="nc-dropdown-webhook-notification"
              @change="onNotTypeChange(true)"
            >
              <a-select-option v-for="(notificationOption, i) in notificationList" :key="i" :value="notificationOption.type">
                <div class="flex items-center">
                  <MdiLink v-if="notificationOption.type === 'URL'" class="mr-2" />

                  <MdiEmail v-if="notificationOption.type === 'Email'" class="mr-2" />

                  <MdiSlack v-if="notificationOption.type === 'Slack'" class="mr-2" />

                  <MdiMicrosoftTeams v-if="notificationOption.type === 'Microsoft Teams'" class="mr-2" />

                  <MdiDiscord v-if="notificationOption.type === 'Discord'" class="mr-2" />

                  <MdiChat v-if="notificationOption.type === 'Mattermost'" class="mr-2" />

                  <MdiWhatsapp v-if="notificationOption.type === 'Whatsapp Twilio'" class="mr-2" />

                  <MdiCellphoneMessage v-if="notificationOption.type === 'Twilio'" class="mr-2" />

                  {{ notificationOption.type }}
                </div>
              </a-select-option>
            </a-select>
          </a-form-item>
        </a-col>
      </a-row>

      <a-row v-if="hook.notification.type === 'URL'" class="mb-5" type="flex" :gutter="[16, 0]">
        <a-col :span="6">
          <a-select
            v-model:value="hook.notification.payload.method"
            size="large"
            class="nc-select-hook-url-method"
            dropdown-class-name="nc-dropdown-hook-notification-url-method"
          >
            <a-select-option v-for="(method, i) in methodList" :key="i" :value="method.title">{{ method.title }}</a-select-option>
          </a-select>
        </a-col>

        <a-col :span="18">
          <a-form-item v-bind="validateInfos['notification.payload.path']">
            <a-input
              v-model:value="hook.notification.payload.path"
              size="large"
              placeholder="http://example.com"
              class="nc-text-field-hook-url-path"
            />
          </a-form-item>
        </a-col>

        <a-col :span="24">
          <a-tabs v-model:activeKey="urlTabKey" type="card" closeable="false" class="shadow-sm">
            <a-tab-pane key="body" tab="Body">
              <MonacoEditor v-model="hook.notification.payload.body" :validate="false" class="min-h-60 max-h-80" />
            </a-tab-pane>
            <a-tab-pane key="params" tab="Params" force-render>
              <ApiClientParams v-model="hook.notification.payload.parameters" />
            </a-tab-pane>
            <a-tab-pane key="headers" tab="Headers" class="nc-tab-headers">
              <ApiClientHeaders v-model="hook.notification.payload.headers" />
            </a-tab-pane>
            <a-tab-pane key="auth" tab="Auth">
              <MonacoEditor v-model="hook.notification.payload.auth" class="min-h-60 max-h-80" />
              <span class="text-gray-500 prose-sm p-2">
                For more about auth option refer
                <a class="prose-sm" href="https://github.com/axios/axios#request-config" target="_blank">axios docs</a>.
              </span>
            </a-tab-pane>
          </a-tabs>
        </a-col>
      </a-row>

      <a-row v-if="hook.notification.type === 'Slack'" type="flex">
        <a-col :span="24">
          <a-form-item v-bind="validateInfos['notification.channels']">
            <WebhookChannelMultiSelect
              v-if="slackChannels.length > 0"
              v-model="hook.notification.payload.channels"
              :selected-channel-list="hook.notification.payload.channels"
              :available-channel-list="slackChannels"
              placeholder="Select Slack channels"
            />
          </a-form-item>
        </a-col>
      </a-row>

      <a-row v-if="hook.notification.type === 'Microsoft Teams'" type="flex">
        <a-col :span="24">
          <a-form-item v-bind="validateInfos['notification.channels']">
            <WebhookChannelMultiSelect
              v-if="teamsChannels.length > 0"
              v-model="hook.notification.payload.channels"
              :selected-channel-list="hook.notification.payload.channels"
              :available-channel-list="teamsChannels"
              placeholder="Select Microsoft Teams channels"
            />
          </a-form-item>
        </a-col>
      </a-row>

      <a-row v-if="hook.notification.type === 'Discord'" type="flex">
        <a-col :span="24">
          <a-form-item v-bind="validateInfos['notification.channels']">
            <WebhookChannelMultiSelect
              v-if="discordChannels.length > 0"
              v-model="hook.notification.payload.channels"
              :selected-channel-list="hook.notification.payload.channels"
              :available-channel-list="discordChannels"
              placeholder="Select Discord channels"
            />
          </a-form-item>
        </a-col>
      </a-row>

      <a-row v-if="hook.notification.type === 'Mattermost'" type="flex">
        <a-col :span="24">
          <a-form-item v-bind="validateInfos['notification.channels']">
            <WebhookChannelMultiSelect
              v-if="mattermostChannels.length > 0"
              v-model="hook.notification.payload.channels"
              :selected-channel-list="hook.notification.payload.channels"
              :available-channel-list="mattermostChannels"
              placeholder="Select Mattermost channels"
            />
          </a-form-item>
        </a-col>
      </a-row>

      <a-row v-if="formInput[hook.notification.type] && hook.notification.payload" type="flex">
        <a-col v-for="(input, i) in formInput[hook.notification.type]" :key="i" :span="24">
          <a-form-item v-if="input.type === 'LongText'" v-bind="validateInfos[`notification.payload.${input.key}`]">
            <a-textarea v-model:value="hook.notification.payload[input.key]" :placeholder="input.label" size="large" />
          </a-form-item>
          <a-form-item v-else v-bind="validateInfos[`notification.payload.${input.key}`]">
            <a-input v-model:value="hook.notification.payload[input.key]" :placeholder="input.label" size="large" />
          </a-form-item>
        </a-col>
      </a-row>

      <a-row class="mb-5" type="flex">
        <a-col :span="24">
          <a-card>
            <a-checkbox v-model:checked="hook.condition" class="nc-check-box-hook-condition">On Condition</a-checkbox>
            <SmartsheetToolbarColumnFilter
              v-if="hook.condition"
              ref="filterRef"
              :auto-save="false"
              :show-loading="false"
              :hook-id="hook.id"
              web-hook
            />
          </a-card>
        </a-col>
      </a-row>

      <a-row>
        <a-col :span="24">
          <div class="text-gray-600">
            <em>Use context variable <strong>data</strong> to refer the record under consideration</em>

            <a-tooltip bottom>
              <template #title>
                <span> <strong>data</strong> : Row data <br /> </span>
              </template>
              <MdiInformation class="ml-2" />
            </a-tooltip>

            <div class="mt-3">
              <a href="https://docs.nocodb.com/developer-resources/webhooks/" target="_blank">
                <!-- Document Reference -->
                {{ $t('labels.docReference') }}
              </a>
            </div>
          </div>
          <WebhookTest
            ref="webhookTestRef"
            :hook="{
              ...hook,
              notification: {
                ...hook.notification,
                payload: hook.notification.payload,
              },
            }"
          />
        </a-col>
      </a-row>
    </a-form-item>
  </a-form>
</template>