refactor: move collection data structures and utility functions to hopp/data

packages/hoppscotch-app/components/collections/ImportExport.vue

@@ -164,7 +164,7 @@
 <script setup lang="ts">
 import { computed, ref, watch } from "@nuxtjs/composition-api"
 import * as E from "fp-ts/Either"
-import { HoppRESTRequest } from "@hoppscotch/data"
+import { HoppRESTRequest, HoppCollection } from "@hoppscotch/data"
 import { apolloClient } from "~/helpers/apollo"
 import {
   useAxios,
@@ -174,11 +174,7 @@ import {
 } from "~/helpers/utils/composables"
 import { currentUser$ } from "~/helpers/fb/auth"
 import * as teamUtils from "~/helpers/teams/utils"
-import {
-  appendRESTCollections,
-  Collection,
-  restCollections$,
-} from "~/newstore/collections"
+import { appendRESTCollections, restCollections$ } from "~/newstore/collections"
 import { RESTCollectionImporters } from "~/helpers/import-export/import/importers"
 import { StepReturnValue } from "~/helpers/import-export/steps"
 
@@ -285,7 +281,7 @@ watch(mySelectedCollectionID, (newValue) => {
 
 const importingMyCollections = ref(false)
 
-const importToTeams = async (content: Collection<HoppRESTRequest>) => {
+const importToTeams = async (content: HoppCollection<HoppRESTRequest>) => {
   importingMyCollections.value = true
   if (props.collectionsType.type !== "team-collections") return
   await teamUtils

packages/hoppscotch-app/components/collections/graphql/Add.vue

@@ -34,8 +34,8 @@
 
 <script lang="ts">
 import { defineComponent } from "@nuxtjs/composition-api"
-import { HoppGQLRequest } from "@hoppscotch/data"
-import { addGraphqlCollection, makeCollection } from "~/newstore/collections"
+import { HoppGQLRequest, makeCollection } from "@hoppscotch/data"
+import { addGraphqlCollection } from "~/newstore/collections"
 
 export default defineComponent({
   props: {

packages/hoppscotch-app/helpers/fb/collections.ts

@@ -5,14 +5,16 @@ import {
   onSnapshot,
   setDoc,
 } from "firebase/firestore"
+import {
+  translateToNewRESTCollection,
+  translateToNewGQLCollection,
+} from "@hoppscotch/data"
 import { currentUser$ } from "./auth"
 import {
   restCollections$,
   graphqlCollections$,
   setRESTCollections,
   setGraphqlCollections,
-  translateToNewRESTCollection,
-  translateToNewGQLCollection,
 } from "~/newstore/collections"
 import { settingsStore } from "~/newstore/settings"
 

packages/hoppscotch-app/helpers/import-export/export/hopp.ts

@@ -1,10 +1,9 @@
-import { HoppRESTRequest } from "@hoppscotch/data"
+import { HoppRESTRequest, HoppCollection } 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) =>
+const exporter: HoppExporter<HoppCollection<HoppRESTRequest>> = (content) =>
   pipe(content, JSON.stringify, TE.right)
 
 export default exporter

packages/hoppscotch-app/helpers/import-export/export/index.ts

@@ -1,6 +1,5 @@
 import * as TE from "fp-ts/TaskEither"
-import { HoppRESTRequest } from "@hoppscotch/data"
-import { Collection } from "~/newstore/collections"
+import { HoppRESTRequest, HoppCollection } from "@hoppscotch/data"
 
 export type HoppExporter<T> = (content: T) => TE.TaskEither<string, string>
 
@@ -10,7 +9,7 @@ export type HoppExporterDefintion<T> = {
 }
 
 export const RESTCollectionExporters: HoppExporterDefintion<
-  Collection<HoppRESTRequest>
+  HoppCollection<HoppRESTRequest>
 >[] = [
   {
     name: "Hoppscotch REST Collection JSON",

packages/hoppscotch-app/helpers/import-export/import/gist.ts

@@ -3,13 +3,14 @@ import * as TE from "fp-ts/TaskEither"
 import * as TO from "fp-ts/TaskOption"
 import * as O from "fp-ts/Option"
 import axios from "axios"
-import { HoppRESTRequest } from "@hoppscotch/data"
+import { HoppRESTRequest, HoppCollection } from "@hoppscotch/data"
 import { step } from "../steps"
 import { defineImporter, IMPORTER_INVALID_FILE_FORMAT } from "."
-import { Collection } from "~/newstore/collections"
 
 // TODO: Add validation to output
-const fetchGist = (url: string): TO.TaskOption<Collection<HoppRESTRequest>> =>
+const fetchGist = (
+  url: string
+): TO.TaskOption<HoppCollection<HoppRESTRequest>> =>
   pipe(
     TO.tryCatch(() =>
       axios.get(`https://api.github.com/gists/${url.split("/").pop()}`, {

packages/hoppscotch-app/helpers/import-export/import/hopp.ts

@@ -1,9 +1,9 @@
 import { pipe } from "fp-ts/function"
 import * as TE from "fp-ts/TaskEither"
 import * as E from "fp-ts/Either"
+import { translateToNewRESTCollection } from "@hoppscotch/data"
 import { step } from "../steps"
 import { defineImporter, IMPORTER_INVALID_FILE_FORMAT } from "."
-import { translateToNewRESTCollection } from "~/newstore/collections"
 
 export default defineImporter({
   name: "import.from_json",

packages/hoppscotch-app/helpers/import-export/import/insomnia.ts

@@ -8,6 +8,8 @@ import {
   HoppRESTRequest,
   knownContentTypes,
   makeRESTRequest,
+  HoppCollection,
+  makeCollection,
 } from "@hoppscotch/data"
 import * as A from "fp-ts/Array"
 import * as S from "fp-ts/string"
@@ -15,7 +17,6 @@ import * as TO from "fp-ts/TaskOption"
 import * as TE from "fp-ts/TaskEither"
 import { step } from "../steps"
 import { defineImporter, IMPORTER_INVALID_FILE_FORMAT } from "."
-import { Collection, makeCollection } from "~/newstore/collections"
 
 // TODO: Insomnia allows custom prefixes for Bearer token auth, Hoppscotch doesn't. We just ignore the prefix for now
 
@@ -194,7 +195,7 @@ const getHoppRequest = (req: InsomniaRequestResource): HoppRESTRequest =>
 const getHoppFolder = (
   folderRes: InsomniaFolderResource,
   resources: InsomniaResource[]
-): Collection<HoppRESTRequest> =>
+): HoppCollection<HoppRESTRequest> =>
   makeCollection({
     name: folderRes.name ?? "",
     folders: getFoldersIn(folderRes, resources).map((f) =>

packages/hoppscotch-app/helpers/import-export/import/openapi.ts

@@ -15,6 +15,8 @@ import {
   HoppRESTRequest,
   knownContentTypes,
   makeRESTRequest,
+  HoppCollection,
+  makeCollection,
 } from "@hoppscotch/data"
 import { pipe, flow } from "fp-ts/function"
 import * as A from "fp-ts/Array"
@@ -24,7 +26,6 @@ import * as TE from "fp-ts/TaskEither"
 import * as RA from "fp-ts/ReadonlyArray"
 import { step } from "../steps"
 import { defineImporter, IMPORTER_INVALID_FILE_FORMAT } from "."
-import { Collection, makeCollection } from "~/newstore/collections"
 
 const OPENAPI_DEREF_ERROR = "openapi/deref_error" as const
 
@@ -558,7 +559,7 @@ const convertPathToHoppReqs = (
 
 const convertOpenApiDocToHopp = (
   doc: OpenAPI.Document
-): TE.TaskEither<never, Collection<HoppRESTRequest>[]> => {
+): TE.TaskEither<never, HoppCollection<HoppRESTRequest>[]> => {
   const name = doc.info.title
 
   const paths = Object.entries(doc.paths ?? {})

packages/hoppscotch-app/helpers/import-export/import/postman.ts

@@ -14,6 +14,8 @@ import {
   HoppRESTReqBody,
   HoppRESTRequest,
   makeRESTRequest,
+  HoppCollection,
+  makeCollection,
 } from "@hoppscotch/data"
 import { pipe, flow } from "fp-ts/function"
 import * as S from "fp-ts/string"
@@ -22,7 +24,6 @@ import * as O from "fp-ts/Option"
 import * as TE from "fp-ts/TaskEither"
 import { step } from "../steps"
 import { defineImporter, IMPORTER_INVALID_FILE_FORMAT } from "."
-import { Collection, makeCollection } from "~/newstore/collections"
 
 const safeParseJSON = (jsonStr: string) => O.tryCatch(() => JSON.parse(jsonStr))
 
@@ -226,7 +227,7 @@ const getHoppRequest = (item: Item): HoppRESTRequest => {
   })
 }
 
-const getHoppFolder = (ig: ItemGroup<Item>): Collection<HoppRESTRequest> =>
+const getHoppFolder = (ig: ItemGroup<Item>): HoppCollection<HoppRESTRequest> =>
   makeCollection({
     name: ig.name,
     folders: pipe(

packages/hoppscotch-app/newstore/collections.ts

@@ -1,22 +1,13 @@
 import { pluck } from "rxjs/operators"
 import {
   HoppGQLRequest,
-  translateToGQLRequest,
   HoppRESTRequest,
-  translateToNewRequest,
+  HoppCollection,
+  makeCollection,
 } from "@hoppscotch/data"
 import DispatchingStore, { defineDispatchers } from "./DispatchingStore"
 import { getRESTSaveContext, setRESTSaveContext } from "./RESTSession"
 
-export interface Collection<T extends HoppRESTRequest | HoppGQLRequest> {
-  v: number
-  name: string
-  folders: Collection<T>[]
-  requests: T[]
-
-  id?: string // For Firestore ID
-}
-
 const defaultRESTCollectionState = {
   state: [
     makeCollection<HoppRESTRequest>({
@@ -37,62 +28,11 @@ const defaultGraphqlCollectionState = {
   ],
 }
 
-export function makeCollection<T extends HoppRESTRequest | HoppGQLRequest>(
-  x: Omit<Collection<T>, "v">
-): Collection<T> {
-  return {
-    v: 1,
-    ...x,
-  }
-}
-
-export function translateToNewRESTCollection(
-  x: any
-): Collection<HoppRESTRequest> {
-  if (x.v && x.v === 1) return x
-
-  // Legacy
-  const name = x.name ?? "Untitled"
-  const folders = (x.folders ?? []).map(translateToNewRESTCollection)
-  const requests = (x.requests ?? []).map(translateToNewRequest)
-
-  const obj = makeCollection<HoppRESTRequest>({
-    name,
-    folders,
-    requests,
-  })
-
-  if (x.id) obj.id = x.id
-
-  return obj
-}
-
-export function translateToNewGQLCollection(
-  x: any
-): Collection<HoppGQLRequest> {
-  if (x.v && x.v === 1) return x
-
-  // Legacy
-  const name = x.name ?? "Untitled"
-  const folders = (x.folders ?? []).map(translateToNewGQLCollection)
-  const requests = (x.requests ?? []).map(translateToGQLRequest)
-
-  const obj = makeCollection<HoppGQLRequest>({
-    name,
-    folders,
-    requests,
-  })
-
-  if (x.id) obj.id = x.id
-
-  return obj
-}
-
 type RESTCollectionStoreType = typeof defaultRESTCollectionState
 type GraphqlCollectionStoreType = typeof defaultGraphqlCollectionState
 
 function navigateToFolderWithIndexPath(
-  collections: Collection<HoppRESTRequest | HoppGQLRequest>[],
+  collections: HoppCollection<HoppRESTRequest | HoppGQLRequest>[],
   indexPaths: number[]
 ) {
   if (indexPaths.length === 0) return null
@@ -108,7 +48,7 @@ function navigateToFolderWithIndexPath(
 const restCollectionDispatchers = defineDispatchers({
   setCollections(
     _: RESTCollectionStoreType,
-    { entries }: { entries: Collection<HoppRESTRequest>[] }
+    { entries }: { entries: HoppCollection<HoppRESTRequest>[] }
   ) {
     return {
       state: entries,
@@ -117,7 +57,7 @@ const restCollectionDispatchers = defineDispatchers({
 
   appendCollections(
     { state }: RESTCollectionStoreType,
-    { entries }: { entries: Collection<HoppRESTRequest>[] }
+    { entries }: { entries: HoppCollection<HoppRESTRequest>[] }
   ) {
     return {
       state: [...state, ...entries],
@@ -126,7 +66,7 @@ const restCollectionDispatchers = defineDispatchers({
 
   addCollection(
     { state }: RESTCollectionStoreType,
-    { collection }: { collection: Collection<any> }
+    { collection }: { collection: HoppCollection<any> }
   ) {
     return {
       state: [...state, collection],
@@ -149,7 +89,7 @@ const restCollectionDispatchers = defineDispatchers({
     {
       collectionIndex,
       collection,
-    }: { collectionIndex: number; collection: Collection<any> }
+    }: { collectionIndex: number; collection: HoppCollection<any> }
   ) {
     return {
       state: state.map((col, index) =>
@@ -162,7 +102,7 @@ const restCollectionDispatchers = defineDispatchers({
     { state }: RESTCollectionStoreType,
     { name, path }: { name: string; path: string }
   ) {
-    const newFolder: Collection<HoppRESTRequest> = makeCollection({
+    const newFolder: HoppCollection<HoppRESTRequest> = makeCollection({
       name,
       folders: [],
       requests: [],
@@ -374,7 +314,7 @@ const restCollectionDispatchers = defineDispatchers({
 const gqlCollectionDispatchers = defineDispatchers({
   setCollections(
     _: GraphqlCollectionStoreType,
-    { entries }: { entries: Collection<any>[] }
+    { entries }: { entries: HoppCollection<any>[] }
   ) {
     return {
       state: entries,
@@ -383,7 +323,7 @@ const gqlCollectionDispatchers = defineDispatchers({
 
   appendCollections(
     { state }: GraphqlCollectionStoreType,
-    { entries }: { entries: Collection<any>[] }
+    { entries }: { entries: HoppCollection<any>[] }
   ) {
     return {
       state: [...state, ...entries],
@@ -392,7 +332,7 @@ const gqlCollectionDispatchers = defineDispatchers({
 
   addCollection(
     { state }: GraphqlCollectionStoreType,
-    { collection }: { collection: Collection<any> }
+    { collection }: { collection: HoppCollection<any> }
   ) {
     return {
       state: [...state, collection],
@@ -415,7 +355,7 @@ const gqlCollectionDispatchers = defineDispatchers({
     {
       collectionIndex,
       collection,
-    }: { collectionIndex: number; collection: Collection<any> }
+    }: { collectionIndex: number; collection: HoppCollection<any> }
   ) {
     return {
       state: state.map((col, index) =>
@@ -428,7 +368,7 @@ const gqlCollectionDispatchers = defineDispatchers({
     { state }: GraphqlCollectionStoreType,
     { name, path }: { name: string; path: string }
   ) {
-    const newFolder: Collection<HoppGQLRequest> = makeCollection({
+    const newFolder: HoppCollection<HoppGQLRequest> = makeCollection({
       name,
       folders: [],
       requests: [],
@@ -650,7 +590,7 @@ export const graphqlCollectionStore = new DispatchingStore(
   gqlCollectionDispatchers
 )
 
-export function setRESTCollections(entries: Collection<HoppRESTRequest>[]) {
+export function setRESTCollections(entries: HoppCollection<HoppRESTRequest>[]) {
   restCollectionStore.dispatch({
     dispatcher: "setCollections",
     payload: {
@@ -667,7 +607,9 @@ export const graphqlCollections$ = graphqlCollectionStore.subject$.pipe(
   pluck("state")
 )
 
-export function appendRESTCollections(entries: Collection<HoppRESTRequest>[]) {
+export function appendRESTCollections(
+  entries: HoppCollection<HoppRESTRequest>[]
+) {
   restCollectionStore.dispatch({
     dispatcher: "appendCollections",
     payload: {
@@ -676,7 +618,7 @@ export function appendRESTCollections(entries: Collection<HoppRESTRequest>[]) {
   })
 }
 
-export function addRESTCollection(collection: Collection<HoppRESTRequest>) {
+export function addRESTCollection(collection: HoppCollection<HoppRESTRequest>) {
   restCollectionStore.dispatch({
     dispatcher: "addCollection",
     payload: {
@@ -700,7 +642,7 @@ export function getRESTCollection(collectionIndex: number) {
 
 export function editRESTCollection(
   collectionIndex: number,
-  collection: Collection<HoppRESTRequest>
+  collection: HoppCollection<HoppRESTRequest>
 ) {
   restCollectionStore.dispatch({
     dispatcher: "editCollection",
@@ -723,7 +665,7 @@ export function addRESTFolder(name: string, path: string) {
 
 export function editRESTFolder(
   path: string,
-  folder: Collection<HoppRESTRequest>
+  folder: HoppCollection<HoppRESTRequest>
 ) {
   restCollectionStore.dispatch({
     dispatcher: "editFolder",
@@ -809,7 +751,9 @@ export function moveRESTRequest(
   })
 }
 
-export function setGraphqlCollections(entries: Collection<HoppGQLRequest>[]) {
+export function setGraphqlCollections(
+  entries: HoppCollection<HoppGQLRequest>[]
+) {
   graphqlCollectionStore.dispatch({
     dispatcher: "setCollections",
     payload: {
@@ -819,7 +763,7 @@ export function setGraphqlCollections(entries: Collection<HoppGQLRequest>[]) {
 }
 
 export function appendGraphqlCollections(
-  entries: Collection<HoppGQLRequest>[]
+  entries: HoppCollection<HoppGQLRequest>[]
 ) {
   graphqlCollectionStore.dispatch({
     dispatcher: "appendCollections",
@@ -829,7 +773,9 @@ export function appendGraphqlCollections(
   })
 }
 
-export function addGraphqlCollection(collection: Collection<HoppGQLRequest>) {
+export function addGraphqlCollection(
+  collection: HoppCollection<HoppGQLRequest>
+) {
   graphqlCollectionStore.dispatch({
     dispatcher: "addCollection",
     payload: {
@@ -849,7 +795,7 @@ export function removeGraphqlCollection(collectionIndex: number) {
 
 export function editGraphqlCollection(
   collectionIndex: number,
-  collection: Collection<HoppGQLRequest>
+  collection: HoppCollection<HoppGQLRequest>
 ) {
   graphqlCollectionStore.dispatch({
     dispatcher: "editCollection",
@@ -872,7 +818,7 @@ export function addGraphqlFolder(name: string, path: string) {
 
 export function editGraphqlFolder(
   path: string,
-  folder: Collection<HoppGQLRequest>
+  folder: HoppCollection<HoppGQLRequest>
 ) {
   graphqlCollectionStore.dispatch({
     dispatcher: "editFolder",

packages/hoppscotch-app/newstore/localpersistence.ts

@@ -8,6 +8,8 @@ import { pipe } from "fp-ts/function"
 import {
   safelyExtractRESTRequest,
   translateToNewRequest,
+  translateToNewRESTCollection,
+  translateToNewGQLCollection,
 } from "@hoppscotch/data"
 import { cloneDeep } from "lodash"
 import {
@@ -31,8 +33,6 @@ import {
   graphqlCollectionStore,
   setGraphqlCollections,
   setRESTCollections,
-  translateToNewRESTCollection,
-  translateToNewGQLCollection,
 } from "./collections"
 import {
   replaceEnvironments,

packages/hoppscotch-app/package.json

@@ -57,7 +57,7 @@
     "@codemirror/tooltip": "^0.19.12",
     "@codemirror/view": "^0.19.39",
     "@hoppscotch/codemirror-lang-graphql": "workspace:^0.1.0",
-    "@hoppscotch/data": "workspace:^0.2.0",
+    "@hoppscotch/data": "workspace:^0.3.0",
     "@hoppscotch/js-sandbox": "workspace:^1.0.0",
     "@nuxtjs/axios": "^5.13.6",
     "@nuxtjs/composition-api": "^0.31.0",

packages/hoppscotch-data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hoppscotch/data",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Data Types, Validations and Migrations for Hoppscotch Public Data Structures",
   "main": "dist/index.js",
   "module": "true",

packages/hoppscotch-data/src/collection/index.ts

@@ -0,0 +1,85 @@
+import { HoppGQLRequest, translateToGQLRequest } from "../graphql";
+import { HoppRESTRequest, translateToNewRequest } from "../rest";
+
+const CURRENT_COLL_SCHEMA_VER = 1
+
+type SupportedReqTypes =
+  | HoppRESTRequest
+  | HoppGQLRequest
+
+export type HoppCollection<T extends SupportedReqTypes> = {
+  v: number
+  name: string
+  folders: HoppCollection<T>[]
+  requests: T[]
+
+  id?: string // For Firestore ID data
+}
+
+/**
+ * Generates a Collection object. This ignores the version number object
+ * so it can be incremented independently without updating it everywhere
+ * @param x The Collection Data
+ * @returns The final collection
+ */
+export function makeCollection<T extends SupportedReqTypes>(
+  x: Omit<HoppCollection<T>, "v">
+): HoppCollection<T> {
+  return {
+    v: CURRENT_COLL_SCHEMA_VER,
+    ...x
+  }
+}
+
+/**
+ * Translates an old collection to a new collection
+ * @param x The collection object to load
+ * @returns The proper new collection format
+ */
+export function translateToNewRESTCollection(
+  x: any
+): HoppCollection<HoppRESTRequest> {
+  if (x.v && x.v === 1) return x
+
+  // Legacy
+  const name = x.name ?? "Untitled"
+  const folders = (x.folders ?? []).map(translateToNewRESTCollection)
+  const requests = (x.requests ?? []).map(translateToNewRequest)
+
+  const obj = makeCollection<HoppRESTRequest>({
+    name,
+    folders,
+    requests,
+  })
+
+  if (x.id) obj.id = x.id
+
+  return obj
+}
+
+/**
+ * Translates an old collection to a new collection
+ * @param x The collection object to load
+ * @returns The proper new collection format
+ */
+export function translateToNewGQLCollection(
+  x: any
+): HoppCollection<HoppGQLRequest> {
+  if (x.v && x.v === 1) return x
+
+  // Legacy
+  const name = x.name ?? "Untitled"
+  const folders = (x.folders ?? []).map(translateToNewGQLCollection)
+  const requests = (x.requests ?? []).map(translateToGQLRequest)
+
+  const obj = makeCollection<HoppGQLRequest>({
+    name,
+    folders,
+    requests,
+  })
+
+  if (x.id) obj.id = x.id
+
+  return obj
+}
+

packages/hoppscotch-data/src/index.ts

@@ -1,2 +1,3 @@
 export * from "./rest"
 export * from "./graphql"
+export * from "./collection"