Open-Source API Development Ecosystem • https://hoppscotch.io • Offline, On-Prem & Cloud • Web, Desktop & CLI • Open-Source Alternative to Postman, Insomnia
TypeScript apiapi-clientapi-restapi-testingdeveloper-toolsgraphqlhttphttp-clientpwarestrest-apispatestingtesting-toolstoolsvuevuejswebsocket
chore: split url and file importer steps
liyasthomas04d73a855d5e
diff --git a/packages/hoppscotch-app/components/collections/ImportExport.vue b/packages/hoppscotch-app/components/collections/ImportExport.vueindex 75b459ec2..4dae3351d 100644--- a/packages/hoppscotch-app/components/collections/ImportExport.vue+++ b/packages/hoppscotch-app/components/collections/ImportExport.vue@@ -1,7 +1,7 @@<template><SmartModalv-if="show"- :title="`${t('modal.import_export')} ${t('modal.collections')}`"+ :title="`${t('modal.collections')}`"max-width="sm:max-w-md"@close="hideModal">@@ -27,49 +27,72 @@/></template><template #body>- <div v-if="importerType !== null" class="relative flex flex-col px-2">- <div- class="absolute top-0 w-0.5 bg-primaryDark left-5 -z-1 bottom-1"- ></div>- <div- v-for="(step, index) in importerSteps"- :key="`step-${index}`"- class="flex flex-col space-y-8"- >- <div v-if="step.name === 'FILE_OR_URL_IMPORT'" class="space-y-4">- <p class="flex items-center">- <span- class="inline-flex items-center justify-center flex-shrink-0 mr-4 rounded-full border-5 border-primary text-secondaryLight"- :class="{- 'text-green-500': hasFile,- }"- >- <i class="material-icons">check_circle</i>- </span>- <span>- {{ t("import.json_description") }}- </span>- </p>- <p class="flex flex-col ml-12">- <input- id="inputChooseFileToImportFrom"- ref="inputChooseFileToImportFrom"- name="inputChooseFileToImportFrom"- type="file"- class="transition cursor-pointer file:transition file:cursor-pointer text-secondaryLight hover:text-secondaryDark file:mr-2 file:py-2 file:px-4 file:rounded file:border-0 file:text-secondary hover:file:text-secondaryDark file:bg-primaryLight hover:file:bg-primaryDark"- :accept="step.metadata.acceptedFileTypes"- @change="onFileChange"- />- </p>+ <div v-if="importerType !== null" class="flex flex-col">+ <div class="relative flex pb-6 flex-col px-2">+ <div+ class="absolute top-0 w-0.5 bg-primaryDark left-5 -z-1 bottom-1"+ ></div>+ <div+ v-for="(step, index) in importerSteps"+ :key="`step-${index}`"+ class="flex flex-col space-y-8"+ >+ <div v-if="step.name === 'FILE_IMPORT'" class="space-y-4">+ <p class="flex items-center">+ <span+ class="inline-flex items-center justify-center flex-shrink-0 mr-4 rounded-full border-5 border-primary text-secondaryLight"+ :class="{+ 'text-green-500': hasFile,+ }"+ >+ <i class="material-icons">check_circle</i>+ </span>+ <span>+ {{ t("import.json_description") }}+ </span>+ </p>+ <p class="flex flex-col ml-11">+ <input+ id="inputChooseFileToImportFrom"+ ref="inputChooseFileToImportFrom"+ name="inputChooseFileToImportFrom"+ type="file"+ class="transition cursor-pointer file:transition file:cursor-pointer text-secondary hover:text-secondaryDark file:mr-2 file:py-2 file:px-4 file:rounded file:border-0 file:text-secondary hover:file:text-secondaryDark file:bg-primaryLight hover:file:bg-primaryDark"+ :accept="step.metadata.acceptedFileTypes"+ @change="onFileChange"+ />+ </p>+ </div>+ <div v-else-if="step.name === 'URL_IMPORT'" class="space-y-4">+ <p class="flex items-center">+ <span+ class="inline-flex items-center justify-center flex-shrink-0 mr-4 rounded-full border-5 border-primary text-secondaryLight"+ :class="{+ 'text-green-500': hasGist,+ }"+ >+ <i class="material-icons">check_circle</i>+ </span>+ <span>+ {{ t("import.gist_description") }}+ </span>+ </p>+ <p class="flex flex-col ml-10">+ <input+ v-model="inputChooseGistToImportFrom"+ type="url"+ class="input"+ :placeholder="`${$t('import.gist_url')}`"+ />+ </p>+ </div></div></div><ButtonPrimary:label="t('import.title')"- class="mt-6":disabled="enableImportButton"@click.native="finishImport"/>- {{ enableImportButton }}</div><div v-else class="flex flex-col px-2"><SmartExpand>@@ -81,7 +104,6 @@:label="t(`${importer.name}`)"@click.native="importerType = index"/>- ---<SmartItemv-if="collectionsType.type == 'team-collections'"v-tippy="{ theme: 'tooltip' }"@@ -90,16 +112,6 @@:label="t('import.from_my_collections')"@click.native="mode = 'import_from_my_collections'"/>- <SmartItem svg="link-2" :label="t('import.from_url')" />- <SmartItem- svg="github"- :label="t('import.from_gist')"- @click.native="- () => {- readCollectionGist()- }- "- /><hr /><SmartItemv-tippy="{ theme: 'tooltip' }"@@ -191,8 +203,7 @@</template><script setup lang="ts">-import { computed, ref } from "@nuxtjs/composition-api"-// import { HoppRESTRequest, translateToNewRequest } from "@hoppscotch/data"+import { computed, ref, watch } from "@nuxtjs/composition-api"import * as E from "fp-ts/Either"import { apolloClient } from "~/helpers/apollo"import {@@ -203,14 +214,7 @@ import {} from "~/helpers/utils/composables"import { currentUser$ } from "~/helpers/fb/auth"import * as teamUtils from "~/helpers/teams/utils"-// import { parseInsomniaCollection } from "~/helpers/utils/parseInsomniaCollection"-import {- appendRESTCollections,- restCollections$,- setRESTCollections,- // Collection,- // makeCollection,-} from "~/newstore/collections"+import { appendRESTCollections, restCollections$ } from "~/newstore/collections"import { RESTCollectionImporters } from "~/helpers/import-export/import/importers"const props = defineProps<{@@ -241,7 +245,7 @@ const mode = ref("import_export")const mySelectedCollectionID = ref(undefined)const collectionJson = ref("")const inputChooseFileToImportFrom = ref<HTMLInputElement | any>()-// const fileName = ref<string>("")+const inputChooseGistToImportFrom = ref<string>("")const getJSONCollection = async () => {if (props.collectionsType.type === "my-collections") {@@ -299,35 +303,6 @@ const failedImport = () => {toast.error(t("import.failed").toString())}-const readCollectionGist = async () => {- const gist = prompt(t("import.gist_url").toString())- if (!gist) return-- try {- const { files } = (await axios.$get(- `https://api.github.com/gists/${gist.split("/").pop()}`,- {- headers: {- Accept: "application/vnd.github.v3+json",- },- }- )) as {- files: {- [fileName: string]: {- content: any- }- }- }-- const collections = JSON.parse(Object.values(files)[0].content)- setRESTCollections(collections)- fileImported()- } catch (e) {- failedImport()- console.error(e)- }-}-const hideModal = () => {mode.value = "import_export"mySelectedCollectionID.value = undefined@@ -413,6 +388,18 @@ const importerAction = async (stepResults: any[]) => {}const hasFile = ref(false)+const hasGist = ref(false)++watch(inputChooseGistToImportFrom, (v) => {+ stepResults.value = []+ if (v === "") {+ hasGist.value = false+ } else {+ hasGist.value = true+ stepResults.value.push(inputChooseGistToImportFrom.value)+ console.log(stepResults.value)+ }+})const onFileChange = () => {if (!inputChooseFileToImportFrom.value[0]) return@@ -447,8 +434,11 @@ const enableImportButton = computed()const resetImport = () => {+ importerType.value = nullstepResults.value = []+ inputChooseFileToImportFrom.value = ""hasFile.value = false- importerType.value = null+ inputChooseGistToImportFrom.value = ""+ hasGist.value = false}</script>diff --git a/packages/hoppscotch-app/components/collections/graphql/ImportExport.vue b/packages/hoppscotch-app/components/collections/graphql/ImportExport.vueindex 749de4c2a..d1698579a 100644--- a/packages/hoppscotch-app/components/collections/graphql/ImportExport.vue+++ b/packages/hoppscotch-app/components/collections/graphql/ImportExport.vue@@ -1,7 +1,7 @@<template><SmartModalv-if="show"- :title="`${t('modal.import_export')} ${t('modal.collections')}`"+ :title="`${t('modal.collections')}`"max-width="sm:max-w-md"@close="hideModal">diff --git a/packages/hoppscotch-app/components/environments/ImportExport.vue b/packages/hoppscotch-app/components/environments/ImportExport.vueindex 359946de6..45e93de87 100644--- a/packages/hoppscotch-app/components/environments/ImportExport.vue+++ b/packages/hoppscotch-app/components/environments/ImportExport.vue@@ -1,7 +1,7 @@<template><SmartModalv-if="show"- :title="`${t('modal.import_export')} ${t('environment.title')}`"+ :title="`${t('environment.title')}`"max-width="sm:max-w-md"@close="hideModal">diff --git a/packages/hoppscotch-app/helpers/import-export/import/gist.ts b/packages/hoppscotch-app/helpers/import-export/import/gist.tsnew file mode 100644index 000000000..6d1029c9e--- /dev/null+++ b/packages/hoppscotch-app/helpers/import-export/import/gist.ts@@ -0,0 +1,41 @@+import { pipe } from "fp-ts/function"+import * as TE from "fp-ts/TaskEither"+import * as E from "fp-ts/Either"+import { step } from "../steps"+import { defineImporter, IMPORTER_INVALID_FILE_FORMAT } from "."+import { translateToNewRESTCollection } from "~/newstore/collections"++export default defineImporter({+ name: "import.gist",+ icon: "github",+ steps: [+ step({+ stepName: "URL_IMPORT",+ metadata: {+ placeholder: "import.gist_url",+ },+ }),+ ] as const,+ importer: ([content]) =>+ pipe(+ E.tryCatch(+ async () => {+ await fetch(+ `https://api.github.com/gists/${content.split("/").pop()}`,+ {+ headers: {+ Accept: "application/vnd.github.v3+json",+ },+ }+ ).then((files) => {+ debugger+ return JSON.parse(Object.values(files)[0].content).map(+ (coll: any) => translateToNewRESTCollection(coll)+ )+ })+ },+ () => IMPORTER_INVALID_FILE_FORMAT+ ),+ TE.fromEither+ ),+})diff --git a/packages/hoppscotch-app/helpers/import-export/import/hopp.ts b/packages/hoppscotch-app/helpers/import-export/import/hopp.tsindex e0741044f..266c7f2b3 100644--- a/packages/hoppscotch-app/helpers/import-export/import/hopp.ts+++ b/packages/hoppscotch-app/helpers/import-export/import/hopp.ts@@ -10,7 +10,7 @@ export default defineImporter({icon: "folder-plus",steps: [step({- stepName: "FILE_OR_URL_IMPORT",+ stepName: "FILE_IMPORT",metadata: {acceptedFileTypes: "application/json",},diff --git a/packages/hoppscotch-app/helpers/import-export/import/importers.ts b/packages/hoppscotch-app/helpers/import-export/import/importers.tsindex 43c49e686..41c281ab2 100644--- a/packages/hoppscotch-app/helpers/import-export/import/importers.ts+++ b/packages/hoppscotch-app/helpers/import-export/import/importers.ts@@ -2,10 +2,12 @@ import HoppRESTCollImporter from "./hopp"import OpenAPIImporter from "./openapi"import PostmanImporter from "./postman"import InsomniaImporter from "./insomnia"+import GistImporter from "./gist"export const RESTCollectionImporters = [HoppRESTCollImporter,OpenAPIImporter,PostmanImporter,InsomniaImporter,+ GistImporter,] as constdiff --git a/packages/hoppscotch-app/helpers/import-export/import/insomnia.ts b/packages/hoppscotch-app/helpers/import-export/import/insomnia.tsindex d96e06549..96f3bb801 100644--- a/packages/hoppscotch-app/helpers/import-export/import/insomnia.ts+++ b/packages/hoppscotch-app/helpers/import-export/import/insomnia.ts@@ -14,7 +14,7 @@ export default defineImporter({icon: "insomnia",steps: [step({- stepName: "FILE_OR_URL_IMPORT",+ stepName: "FILE_IMPORT",metadata: {acceptedFileTypes: ".json",},diff --git a/packages/hoppscotch-app/helpers/import-export/import/openapi.ts b/packages/hoppscotch-app/helpers/import-export/import/openapi.tsindex 8ce706f25..52cf127fa 100644--- a/packages/hoppscotch-app/helpers/import-export/import/openapi.ts+++ b/packages/hoppscotch-app/helpers/import-export/import/openapi.ts@@ -589,7 +589,7 @@ export default defineImporter({icon: "file",steps: [step({- stepName: "FILE_OR_URL_IMPORT",+ stepName: "FILE_IMPORT",metadata: {acceptedFileTypes: ".json, .yaml, .yml",},diff --git a/packages/hoppscotch-app/helpers/import-export/import/postman.ts b/packages/hoppscotch-app/helpers/import-export/import/postman.tsindex a1040e134..bc6b4da6e 100644--- a/packages/hoppscotch-app/helpers/import-export/import/postman.ts+++ b/packages/hoppscotch-app/helpers/import-export/import/postman.ts@@ -183,7 +183,7 @@ export default defineImporter({icon: "postman",steps: [step({- stepName: "FILE_OR_URL_IMPORT",+ stepName: "FILE_IMPORT",metadata: {acceptedFileTypes: ".json",},diff --git a/packages/hoppscotch-app/helpers/import-export/steps.ts b/packages/hoppscotch-app/helpers/import-export/steps.tsindex cc54521c2..6d39bdae1 100644--- a/packages/hoppscotch-app/helpers/import-export/steps.ts+++ b/packages/hoppscotch-app/helpers/import-export/steps.ts@@ -3,16 +3,22 @@* Add an entry here when you define a step*/export type StepDefinition = {- FILE_OR_URL_IMPORT: {+ FILE_IMPORT: {returnType: stringmetadata: {acceptedFileTypes: string}- } // String content of the file/url+ } // String content of the fileTARGET_MY_COLLECTION: {returnType: numbermetadata: never} // folderPath+ URL_IMPORT: {+ returnType: string+ metadata: {+ placeholder: string+ }+ } // String content of the url}/**diff --git a/packages/hoppscotch-app/locales/en.json b/packages/hoppscotch-app/locales/en.jsonindex 74bb74ebe..cc858b72c 100644--- a/packages/hoppscotch-app/locales/en.json+++ b/packages/hoppscotch-app/locales/en.json@@ -229,7 +229,8 @@"collections": "Import collections","curl": "Import cURL","failed": "Error while importing: format not recognized",- "from_gist": "Import from Gist",+ "gist": "Import from Gist",+ "gist_description": "Import a Gist","from_insomnia": "Import from Insomnia","from_my_collections": "Import from My Collections","from_openapi": "Import from OpenAPI",