Skip to content

Open-Source API Development Ecosystem • https://hoppscotch.io • Offline, On-Prem & Cloud • Web, Desktop & CLI • Open-Source Alternative to Postman, Insomnia

refactor: import/export new architecture

Andrew Bastin681a957611fa
diff --git a/packages/hoppscotch-app/helpers/import-export/export/hopp.ts b/packages/hoppscotch-app/helpers/import-export/export/hopp.ts
new file mode 100644
index 000000000..900079412
--- /dev/null
+++ b/packages/hoppscotch-app/helpers/import-export/export/hopp.ts
@@ -0,0 +1,10 @@
+import { HoppRESTRequest } from "@hoppscotch/data"
+import { pipe } from "fp-ts/function"
+import * as TE from "fp-ts/TaskEither"
+import { HoppExporter } from "."
+import { Collection } from "~/newstore/collections"
+
+const exporter: HoppExporter<Collection<HoppRESTRequest>> = (content) =>
+ pipe(content, JSON.stringify, TE.right)
+
+export default exporter
diff --git a/packages/hoppscotch-app/helpers/import-export/export/index.ts b/packages/hoppscotch-app/helpers/import-export/export/index.ts
new file mode 100644
index 000000000..058fa57b4
--- /dev/null
+++ b/packages/hoppscotch-app/helpers/import-export/export/index.ts
@@ -0,0 +1,19 @@
+import * as TE from "fp-ts/TaskEither"
+import { HoppRESTRequest } from "@hoppscotch/data"
+import { Collection } from "~/newstore/collections"
+
+export type HoppExporter<T> = (content: T) => TE.TaskEither<string, string>
+
+export type HoppExporterDefintion<T> = {
+ name: string
+ exporter: () => Promise<HoppExporter<T>>
+}
+
+export const RESTCollectionExporters: HoppExporterDefintion<
+ Collection<HoppRESTRequest>
+>[] = [
+ {
+ name: "Hoppscotch REST Collection JSON",
+ exporter: () => import("./hopp").then((m) => m.default),
+ },
+]
diff --git a/packages/hoppscotch-app/helpers/import-export/import/hopp.ts b/packages/hoppscotch-app/helpers/import-export/import/hopp.ts
new file mode 100644
index 000000000..bd7877c06
--- /dev/null
+++ b/packages/hoppscotch-app/helpers/import-export/import/hopp.ts
@@ -0,0 +1,20 @@
+import { HoppRESTRequest } from "@hoppscotch/data"
+import { pipe } from "fp-ts/function"
+import * as TE from "fp-ts/TaskEither"
+import * as E from "fp-ts/Either"
+import { HoppImporter, IMPORTER_INVALID_FILE_FORMAT } from "."
+import {
+ Collection,
+ translateToNewRESTCollection,
+} from "~/newstore/collections"
+
+const importer: HoppImporter<Collection<HoppRESTRequest>> = (content) =>
+ pipe(
+ E.tryCatch(
+ () => translateToNewRESTCollection(content),
+ () => IMPORTER_INVALID_FILE_FORMAT
+ ),
+ TE.fromEither
+ )
+
+export default importer
diff --git a/packages/hoppscotch-app/helpers/import-export/import/index.ts b/packages/hoppscotch-app/helpers/import-export/import/index.ts
new file mode 100644
index 000000000..090c23f03
--- /dev/null
+++ b/packages/hoppscotch-app/helpers/import-export/import/index.ts
@@ -0,0 +1,39 @@
+import * as TE from "fp-ts/TaskEither"
+import { HoppRESTRequest } from "@hoppscotch/data"
+import { Collection } from "~/newstore/collections"
+
+/**
+ * The error state to be used when the file formats do not match
+ */
+export const IMPORTER_INVALID_FILE_FORMAT =
+ "importer_invalid_file_format" as const
+
+export type HoppImporterError = typeof IMPORTER_INVALID_FILE_FORMAT
+
+export type HoppImporter<T> = (
+ content: string
+) => TE.TaskEither<HoppImporterError, T>
+
+/**
+ * Definition for importers
+ */
+export type HoppImporterDefintion<T> = {
+ /**
+ * Name of the importer, shown on the Select Importer dropdown
+ */
+ name: string
+
+ /**
+ * The importer function, It is a Promise because its supposed to be loaded in lazily (dynamic imports ?)
+ */
+ importer: () => Promise<HoppImporter<T>>
+}
+
+export const RESTCollectionImporters: HoppImporterDefintion<
+ Collection<HoppRESTRequest>
+>[] = [
+ {
+ name: "Hoppscotch REST Collection",
+ importer: () => import("./hopp").then((m) => m.default),
+ },
+]