hoppscotch/packages/hoppscotch-app/components/http/Parameters.vue

<template>
  <AppSection label="parameters">
    <div
      class="
        bg-primary
        border-dividerLight
        top-upperSecondaryStickyFold
        sticky
        z-10
        flex
        items-center
        justify-between
        flex-1
        pl-4
        border-b
      "
    >
      <label class="font-semibold text-secondaryLight">
        {{ t("request.parameter_list") }}
      </label>
      <div class="flex">
        <ButtonSecondary
          v-tippy="{ theme: 'tooltip' }"
          to="https://docs.hoppscotch.io/features/parameters"
          blank
          :title="t('app.wiki')"
          svg="help-circle"
        />
        <ButtonSecondary
          v-tippy="{ theme: 'tooltip' }"
          :title="t('action.clear_all')"
          svg="trash-2"
          @click.native="clearContent()"
        />
        <ButtonSecondary
          v-tippy="{ theme: 'tooltip' }"
          :title="t('state.bulk_mode')"
          svg="edit"
          :class="{ '!text-accent': bulkMode }"
          @click.native="bulkMode = !bulkMode"
        />
        <ButtonSecondary
          v-tippy="{ theme: 'tooltip' }"
          :title="t('add.new')"
          svg="plus"
          :disabled="bulkMode"
          @click.native="addParam"
        />
      </div>
    </div>
    <div v-if="bulkMode" ref="bulkEditor"></div>
    <div v-else>
      <div
        v-for="(param, index) in params$"
        :key="`param-${index}`"
        class="flex border-b divide-dividerLight border-dividerLight divide-x"
      >
        <SmartEnvInput
          v-model="param.key"
          :placeholder="`${t('count.parameter', { count: index + 1 })}`"
          styles="
            bg-transparent
            flex
            flex-1
            py-1
            px-4
          "
          @change="
            updateParam(index, {
              key: $event,
              value: param.value,
              active: param.active,
            })
          "
        />
        <SmartEnvInput
          v-model="param.value"
          :placeholder="`${t('count.value', { count: index + 1 })}`"
          styles="
            bg-transparent
            flex
            flex-1
            py-1
            px-4
          "
          @change="
            updateParam(index, {
              key: param.key,
              value: $event,
              active: param.active,
            })
          "
        />
        <span>
          <ButtonSecondary
            v-tippy="{ theme: 'tooltip' }"
            :title="
              param.hasOwnProperty('active')
                ? param.active
                  ? t('action.turn_off')
                  : t('action.turn_on')
                : t('action.turn_off')
            "
            :svg="
              param.hasOwnProperty('active')
                ? param.active
                  ? 'check-circle'
                  : 'circle'
                : 'check-circle'
            "
            color="green"
            @click.native="
              updateParam(index, {
                key: param.key,
                value: param.value,
                active: param.hasOwnProperty('active') ? !param.active : false,
              })
            "
          />
        </span>
        <span>
          <ButtonSecondary
            v-tippy="{ theme: 'tooltip' }"
            :title="t('action.remove')"
            svg="trash"
            color="red"
            @click.native="deleteParam(index)"
          />
        </span>
      </div>
      <div
        v-if="params$.length === 0"
        class="
          flex
          text-secondaryLight
          flex-col
          items-center
          justify-center
          p-4
        "
      >
        <img
          :src="`/images/states/${$colorMode.value}/add_files.svg`"
          loading="lazy"
          class="
            object-contain
            inline-flex
            flex-col
            object-center
            w-16
            h-16
            my-4
          "
          :alt="`${t('empty.parameters')}`"
        />
        <span class="pb-4 text-center">
          {{ t("empty.parameters") }}
        </span>
        <ButtonSecondary
          :label="`${t('add.new')}`"
          svg="plus"
          filled
          class="mb-4"
          @click.native="addParam"
        />
      </div>
    </div>
  </AppSection>
</template>

<script setup lang="ts">
import { ref, watch, onBeforeUpdate } from "@nuxtjs/composition-api"
import { useCodemirror } from "~/helpers/editor/codemirror"
import { HoppRESTParam } from "~/helpers/types/HoppRESTRequest"
import {
  useReadonlyStream,
  useI18n,
  useToast,
} from "~/helpers/utils/composables"
import {
  restParams$,
  addRESTParam,
  updateRESTParam,
  deleteRESTParam,
  deleteAllRESTParams,
  setRESTParams,
} from "~/newstore/RESTSession"

const t = useI18n()

const toast = useToast()

const bulkMode = ref(false)
const bulkParams = ref("")

watch(bulkParams, () => {
  try {
    const transformation = bulkParams.value.split("\n").map((item) => ({
      key: item.substring(0, item.indexOf(":")).trim().replace(/^\/\//, ""),
      value: item.substring(item.indexOf(":") + 1).trim(),
      active: !item.trim().startsWith("//"),
    }))
    setRESTParams(transformation as HoppRESTParam[])
  } catch (e) {
    toast.error(`${t("error.something_went_wrong")}`)
    console.error(e)
  }
})

const bulkEditor = ref<any | null>(null)

useCodemirror(bulkEditor, bulkParams, {
  extendedEditorConfig: {
    mode: "text/x-yaml",
    placeholder: `${t("state.bulk_mode_placeholder")}`,
  },
  linter: null,
  completer: null,
})

const params$ = useReadonlyStream(restParams$, [])

watch(
  params$,
  (newValue) => {
    if (!bulkMode.value)
      if (
        (newValue[newValue.length - 1]?.key !== "" ||
          newValue[newValue.length - 1]?.value !== "") &&
        newValue.length
      )
        addParam()
  },
  { deep: true }
)

onBeforeUpdate(() => editBulkParamsLine(-1, null))

const editBulkParamsLine = (index: number, item?: HoppRESTParam | null) => {
  const params = params$.value

  bulkParams.value = params
    .reduce((all, param, pIndex) => {
      const current =
        index === pIndex && item != null
          ? `${item.active ? "" : "//"}${item.key}: ${item.value}`
          : `${param.active ? "" : "//"}${param.key}: ${param.value}`
      return [...all, current]
    }, [])
    .join("\n")
}

const clearBulkEditor = () => {
  bulkParams.value = ""
}

const addParam = () => {
  const empty = { key: "", value: "", active: true }
  const index = params$.value.length

  addRESTParam(empty)
  editBulkParamsLine(index, empty)
}

const updateParam = (index: number, item: HoppRESTParam) => {
  updateRESTParam(index, item)
  editBulkParamsLine(index, item)
}

const deleteParam = (index: number) => {
  const parametersBeforeDeletion = params$.value

  deleteRESTParam(index)
  editBulkParamsLine(index, null)

  const deletedItem = parametersBeforeDeletion[index]
  if (deletedItem.key || deletedItem.value) {
    toast.success(`${t("state.deleted")}`, {
      action: [
        {
          text: `${t("action.undo")}`,
          onClick: (_, toastObject) => {
            setRESTParams(parametersBeforeDeletion as HoppRESTParam[])
            editBulkParamsLine(index, deletedItem)
            toastObject.goAway(0)
          },
        },
      ],
    })
  }
}

const clearContent = () => {
  deleteAllRESTParams()
  clearBulkEditor()
}
</script>