feat: rest revamp (#2918)

Co-authored-by: Liyas Thomas <liyascthomas@gmail.com>
Co-authored-by: Nivedin <53208152+nivedin@users.noreply.github.com>
Co-authored-by: Andrew Bastin <andrewbastin.k@gmail.com>

packages/hoppscotch-common/src/helpers/collection/affectedIndex.ts

@@ -0,0 +1,21 @@
+/**
+ * Get the indexes that are affected by the reorder
+ * @param from index of the item before reorder
+ * @param to index of the item after reorder
+ * @returns Map of from to to
+ */
+
+export function getAffectedIndexes(from: number, to: number) {
+  const indexes = new Map<number, number>()
+  indexes.set(from, to)
+  if (from < to) {
+    for (let i = from + 1; i <= to; i++) {
+      indexes.set(i, i - 1)
+    }
+  } else {
+    for (let i = from - 1; i >= to; i--) {
+      indexes.set(i, i + 1)
+    }
+  }
+  return indexes
+}

packages/hoppscotch-common/src/helpers/collection/collection.ts

@@ -0,0 +1,141 @@
+import { HoppCollection, HoppRESTRequest } from "@hoppscotch/data"
+import { getTabsRefTo } from "../rest/tab"
+import { getAffectedIndexes } from "./affectedIndex"
+
+/**
+ * Resolve save context on reorder
+ * @param payload
+ * @param payload.lastIndex
+ * @param payload.newIndex
+ * @param folderPath
+ * @param payload.length
+ * @returns
+ */
+
+export function resolveSaveContextOnCollectionReorder(
+  payload: {
+    lastIndex: number
+    newIndex: number
+    folderPath: string
+    length?: number // better way to do this? now it could be undefined
+  },
+  type: "remove" | "drop" = "remove"
+) {
+  const { lastIndex, folderPath, length } = payload
+  let { newIndex } = payload
+
+  if (newIndex > lastIndex) newIndex-- // there is a issue when going down? better way to resolve this?
+  if (lastIndex === newIndex) return
+
+  const affectedIndexes = getAffectedIndexes(
+    lastIndex,
+    newIndex === -1 ? length! : newIndex
+  )
+
+  if (newIndex === -1) {
+    // if (newIndex === -1) remove it from the map because it will be deleted
+    affectedIndexes.delete(lastIndex)
+    // when collection deleted opended requests from that collection be affected
+    if (type === "remove") {
+      resetSaveContextForAffectedRequests(
+        folderPath ? `${folderPath}/${lastIndex}` : lastIndex.toString()
+      )
+    }
+  }
+
+  // add folder path as prefix to the affected indexes
+  const affectedPaths = new Map<string, string>()
+  for (const [key, value] of affectedIndexes) {
+    if (folderPath) {
+      affectedPaths.set(`${folderPath}/${key}`, `${folderPath}/${value}`)
+    } else {
+      affectedPaths.set(key.toString(), value.toString())
+    }
+  }
+
+  const tabs = getTabsRefTo((tab) => {
+    return (
+      tab.document.saveContext?.originLocation === "user-collection" &&
+      affectedPaths.has(tab.document.saveContext.folderPath)
+    )
+  })
+
+  for (const tab of tabs) {
+    if (tab.value.document.saveContext?.originLocation === "user-collection") {
+      const newPath = affectedPaths.get(
+        tab.value.document.saveContext?.folderPath
+      )!
+      tab.value.document.saveContext.folderPath = newPath
+    }
+  }
+}
+
+/**
+ * Resolve save context for affected requests on drop folder from one  to another
+ * @param oldFolderPath
+ * @param newFolderPath
+ * @returns
+ */
+
+export function updateSaveContextForAffectedRequests(
+  oldFolderPath: string,
+  newFolderPath: string
+) {
+  const tabs = getTabsRefTo((tab) => {
+    return (
+      tab.document.saveContext?.originLocation === "user-collection" &&
+      tab.document.saveContext.folderPath.startsWith(oldFolderPath)
+    )
+  })
+
+  for (const tab of tabs) {
+    if (tab.value.document.saveContext?.originLocation === "user-collection") {
+      tab.value.document.saveContext = {
+        ...tab.value.document.saveContext,
+        folderPath: tab.value.document.saveContext.folderPath.replace(
+          oldFolderPath,
+          newFolderPath
+        ),
+      }
+    }
+  }
+}
+
+function resetSaveContextForAffectedRequests(folderPath: string) {
+  const tabs = getTabsRefTo((tab) => {
+    return (
+      tab.document.saveContext?.originLocation === "user-collection" &&
+      tab.document.saveContext.folderPath.startsWith(folderPath)
+    )
+  })
+
+  for (const tab of tabs) {
+    tab.value.document.saveContext = null
+    tab.value.document.isDirty = true
+  }
+}
+
+export function getFoldersByPath(
+  collections: HoppCollection<HoppRESTRequest>[],
+  path: string
+): HoppCollection<HoppRESTRequest>[] {
+  if (!path) return collections
+
+  // path will be like this "0/0/1" these are the indexes of the folders
+  const pathArray = path.split("/").map((index) => parseInt(index))
+
+  console.log(pathArray, collections[pathArray[0]])
+
+  let currentCollection = collections[pathArray[0]]
+
+  if (pathArray.length === 1) {
+    return currentCollection.folders
+  } else {
+    for (let i = 1; i < pathArray.length; i++) {
+      const folder = currentCollection.folders[pathArray[i]]
+      if (folder) currentCollection = folder
+    }
+  }
+
+  return currentCollection.folders
+}

packages/hoppscotch-common/src/helpers/collection/request.ts

@@ -0,0 +1,72 @@
+import { HoppCollection, HoppRESTRequest } from "@hoppscotch/data"
+import { getTabsRefTo } from "../rest/tab"
+import { getAffectedIndexes } from "./affectedIndex"
+
+/**
+ * Resolve save context on reorder
+ * @param payload
+ * @param payload.lastIndex
+ * @param payload.newIndex
+ * @param payload.folderPath
+ * @param payload.length
+ * @returns
+ */
+
+export function resolveSaveContextOnRequestReorder(payload: {
+  lastIndex: number
+  folderPath: string
+  newIndex: number
+  length?: number // better way to do this? now it could be undefined
+}) {
+  const { lastIndex, folderPath, length } = payload
+  let { newIndex } = payload
+
+  if (newIndex > lastIndex) newIndex-- // there is a issue when going down? better way to resolve this?
+  if (lastIndex === newIndex) return
+
+  const affectedIndexes = getAffectedIndexes(
+    lastIndex,
+    newIndex === -1 ? length! : newIndex
+  )
+
+  // if (newIndex === -1) remove it from the map because it will be deleted
+  if (newIndex === -1) affectedIndexes.delete(lastIndex)
+
+  const tabs = getTabsRefTo((tab) => {
+    return (
+      tab.document.saveContext?.originLocation === "user-collection" &&
+      tab.document.saveContext.folderPath === folderPath &&
+      affectedIndexes.has(tab.document.saveContext.requestIndex)
+    )
+  })
+
+  for (const tab of tabs) {
+    if (tab.value.document.saveContext?.originLocation === "user-collection") {
+      const newIndex = affectedIndexes.get(
+        tab.value.document.saveContext?.requestIndex
+      )!
+      tab.value.document.saveContext.requestIndex = newIndex
+    }
+  }
+}
+
+export function getRequestsByPath(
+  collections: HoppCollection<HoppRESTRequest>[],
+  path: string
+): HoppRESTRequest[] {
+  // path will be like this "0/0/1" these are the indexes of the folders
+  const pathArray = path.split("/").map((index) => parseInt(index))
+
+  let currentCollection = collections[pathArray[0]]
+
+  if (pathArray.length === 1) {
+    return currentCollection.requests
+  } else {
+    for (let i = 1; i < pathArray.length; i++) {
+      const folder = currentCollection.folders[pathArray[i]]
+      if (folder) currentCollection = folder
+    }
+  }
+
+  return currentCollection.requests
+}