Skip to content

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

feat: rest revamp (#2918)

Anwarul Islamdefece95fc5f
diff --git a/packages/hoppscotch-common/locales/en.json b/packages/hoppscotch-common/locales/en.json
index 59f6f6157..d298e286a 100644
--- a/packages/hoppscotch-common/locales/en.json
+++ b/packages/hoppscotch-common/locales/en.json
@@ -138,6 +138,7 @@
},
"confirm": {
"exit_team": "Are you sure you want to leave this team?",
+ "save_unsaved_tab": "Do you want to save changes made in this tab ?",
"logout": "Are you sure you want to logout?",
"remove_collection": "Are you sure you want to permanently delete this collection?",
"remove_environment": "Are you sure you want to permanently delete this environment?",
@@ -317,6 +318,7 @@
"modal": {
"collections": "Collections",
"confirm": "Confirm",
+ "close_unsaved_tab": "Close Unsaved Tab ?",
"edit_request": "Edit Request",
"import_export": "Import / Export"
},
diff --git a/packages/hoppscotch-common/src/components.d.ts b/packages/hoppscotch-common/src/components.d.ts
index 40471f3c5..9fc832795 100644
--- a/packages/hoppscotch-common/src/components.d.ts
+++ b/packages/hoppscotch-common/src/components.d.ts
@@ -89,7 +89,11 @@ declare module '@vue/runtime-core' {
HoppSmartSpinner: typeof import('@hoppscotch/ui')['HoppSmartSpinner']
HoppSmartTab: typeof import('@hoppscotch/ui')['HoppSmartTab']
HoppSmartTabs: typeof import('@hoppscotch/ui')['HoppSmartTabs']
+ HoppSmartWindow: typeof import('@hoppscotch/ui')['HoppSmartWindow']
+ HoppSmartWindows: typeof import('@hoppscotch/ui')['HoppSmartWindows']
HttpAuthorization: typeof import('./components/http/Authorization.vue')['default']
+ HttpAuthorizationApiKey: typeof import('./components/http/authorization/ApiKey.vue')['default']
+ HttpAuthorizationBasic: typeof import('./components/http/authorization/Basic.vue')['default']
HttpBody: typeof import('./components/http/Body.vue')['default']
HttpBodyParameters: typeof import('./components/http/BodyParameters.vue')['default']
HttpCodegenModal: typeof import('./components/http/CodegenModal.vue')['default']
@@ -102,6 +106,7 @@ declare module '@vue/runtime-core' {
HttpReqChangeConfirmModal: typeof import('./components/http/ReqChangeConfirmModal.vue')['default']
HttpRequest: typeof import('./components/http/Request.vue')['default']
HttpRequestOptions: typeof import('./components/http/RequestOptions.vue')['default']
+ HttpRequestTab: typeof import('./components/http/RequestTab.vue')['default']
HttpResponse: typeof import('./components/http/Response.vue')['default']
HttpResponseMeta: typeof import('./components/http/ResponseMeta.vue')['default']
HttpSidebar: typeof import('./components/http/Sidebar.vue')['default']
diff --git a/packages/hoppscotch-common/src/components/app/PaneLayout.vue b/packages/hoppscotch-common/src/components/app/PaneLayout.vue
index 7763abe1c..486a58cd6 100644
--- a/packages/hoppscotch-common/src/components/app/PaneLayout.vue
+++ b/packages/hoppscotch-common/src/components/app/PaneLayout.vue
@@ -22,6 +22,7 @@
<slot name="primary" />
</Pane>
<Pane
+ v-if="hasSecondary"
:size="PANE_MAIN_BOTTOM_SIZE"
class="flex flex-col !overflow-auto"
>
@@ -62,6 +63,7 @@ const SIDEBAR = useSetting("SIDEBAR")
const slots = useSlots()
const hasSidebar = computed(() => !!slots.sidebar)
+const hasSecondary = computed(() => !!slots.secondary)
const props = defineProps({
layoutId: {
diff --git a/packages/hoppscotch-common/src/components/collections/AddRequest.vue b/packages/hoppscotch-common/src/components/collections/AddRequest.vue
index 23bcd729c..5f186a09e 100644
--- a/packages/hoppscotch-common/src/components/collections/AddRequest.vue
+++ b/packages/hoppscotch-common/src/components/collections/AddRequest.vue
@@ -43,7 +43,7 @@
import { ref, watch } from "vue"
import { useI18n } from "@composables/i18n"
import { useToast } from "@composables/toast"
-import { getRESTRequest } from "~/newstore/RESTSession"
+import { currentActiveTab } from "~/helpers/rest/tab"
const toast = useToast()
const t = useI18n()
@@ -70,7 +70,7 @@ watch(
() => props.show,
(show) => {
if (show) {
- name.value = getRESTRequest().name
+ name.value = currentActiveTab.value.document.request.name
}
}
)
diff --git a/packages/hoppscotch-common/src/components/collections/Collection.vue b/packages/hoppscotch-common/src/components/collections/Collection.vue
index f368409fd..9a8695a3e 100644
--- a/packages/hoppscotch-common/src/components/collections/Collection.vue
+++ b/packages/hoppscotch-common/src/components/collections/Collection.vue
@@ -203,7 +203,7 @@ const props = defineProps({
parentID: {
type: String as PropType<string | null>,
default: null,
- required: true,
+ required: false,
},
data: {
type: Object as PropType<HoppCollection<HoppRESTRequest> | TeamCollection>,
diff --git a/packages/hoppscotch-common/src/components/collections/MyCollections.vue b/packages/hoppscotch-common/src/components/collections/MyCollections.vue
index 759b7ad69..d09b93a45 100644
--- a/packages/hoppscotch-common/src/components/collections/MyCollections.vue
+++ b/packages/hoppscotch-common/src/components/collections/MyCollections.vue
@@ -298,11 +298,10 @@ import { GetMyTeamsQuery } from "~/helpers/backend/graphql"
import { ChildrenResult, SmartTreeAdapter } from "~/helpers/treeAdapter"
import { useI18n } from "@composables/i18n"
import { useColorMode } from "@composables/theming"
-import { useReadonlyStream } from "~/composables/stream"
-import { restSaveContext$ } from "~/newstore/RESTSession"
import { pipe } from "fp-ts/function"
import * as O from "fp-ts/Option"
import { Picked } from "~/helpers/types/HoppPicked.js"
+import { currentActiveTab } from "~/helpers/rest/tab"
export type Collection = {
type: "collections"
@@ -508,23 +507,21 @@ const isSelected = computed(() => {
}
})
-const active = useReadonlyStream(restSaveContext$, null)
-
-const isActiveRequest = computed(() => {
- return (folderPath: string, requestIndex: number) => {
- return pipe(
- active.value,
- O.fromNullable,
- O.filter(
- (active) =>
- active.originLocation === "user-collection" &&
- active.folderPath === folderPath &&
- active.requestIndex === requestIndex
- ),
- O.isSome
- )
- }
-})
+const active = computed(() => currentActiveTab.value.document.saveContext)
+
+const isActiveRequest = (folderPath: string, requestIndex: number) => {
+ return pipe(
+ active.value,
+ O.fromNullable,
+ O.filter(
+ (active) =>
+ active.originLocation === "user-collection" &&
+ active.folderPath === folderPath &&
+ active.requestIndex === requestIndex
+ ),
+ O.isSome
+ )
+}
const selectRequest = (data: {
request: HoppRESTRequest
@@ -532,6 +529,7 @@ const selectRequest = (data: {
requestIndex: string
}) => {
const { request, folderPath, requestIndex } = data
+
if (props.saveRequest) {
emit("select", {
pickedType: "my-request",
@@ -543,7 +541,7 @@ const selectRequest = (data: {
request,
folderPath,
requestIndex,
- isActive: isActiveRequest.value(folderPath, parseInt(requestIndex)),
+ isActive: isActiveRequest(folderPath, parseInt(requestIndex)),
})
}
}
diff --git a/packages/hoppscotch-common/src/components/collections/Request.vue b/packages/hoppscotch-common/src/components/collections/Request.vue
index 6014710ce..3aab24047 100644
--- a/packages/hoppscotch-common/src/components/collections/Request.vue
+++ b/packages/hoppscotch-common/src/components/collections/Request.vue
@@ -152,14 +152,12 @@ import { ref, PropType, watch, computed } from "vue"
import { HoppRESTRequest } from "@hoppscotch/data"
import { useI18n } from "@composables/i18n"
import { TippyComponent } from "vue-tippy"
-import { pipe } from "fp-ts/function"
-import * as RR from "fp-ts/ReadonlyRecord"
-import * as O from "fp-ts/Option"
import {
changeCurrentReorderStatus,
currentReorderingStatus$,
} from "~/newstore/reordering"
import { useReadonlyStream } from "~/composables/stream"
+import { getMethodLabelColorClassOf } from "~/helpers/rest/labelColoring"
type CollectionType = "my-collections" | "team-collections"
@@ -242,20 +240,8 @@ const currentReorderingStatus = useReadonlyStream(currentReorderingStatus$, {
parentID: "",
})
-const requestMethodLabels = {
- get: "text-green-500",
- post: "text-yellow-500",
- put: "text-blue-500",
- delete: "text-red-500",
- default: "text-gray-500",
-} as const
-
const requestLabelColor = computed(() =>
- pipe(
- requestMethodLabels,
- RR.lookup(props.request.method.toLowerCase()),
- O.getOrElseW(() => requestMethodLabels.default)
- )
+ getMethodLabelColorClassOf(props.request)
)
watch(
diff --git a/packages/hoppscotch-common/src/components/collections/SaveRequest.vue b/packages/hoppscotch-common/src/components/collections/SaveRequest.vue
index b342b44d6..b10e16d22 100644
--- a/packages/hoppscotch-common/src/components/collections/SaveRequest.vue
+++ b/packages/hoppscotch-common/src/components/collections/SaveRequest.vue
@@ -1,3 +1,4 @@
+<!-- eslint-disable prettier/prettier -->
<template>
<HoppSmartModal
v-if="show"
@@ -61,8 +62,8 @@
</template>
<script setup lang="ts">
-import { useI18n } from "@composables/i18n"
-import { useToast } from "@composables/toast"
+import { reactive, ref, watch } from "vue"
+import { cloneDeep } from "lodash-es"
import {
HoppGQLRequest,
HoppRESTRequest,
@@ -70,8 +71,6 @@ import {
} from "@hoppscotch/data"
import { pipe } from "fp-ts/function"
import * as TE from "fp-ts/TaskEither"
-import { cloneDeep } from "lodash-es"
-import { reactive, ref, watch } from "vue"
import { GetMyTeamsQuery } from "~/helpers/backend/graphql"
import {
createRequestInCollection,
@@ -79,11 +78,8 @@ import {
} from "~/helpers/backend/mutations/TeamRequest"
import { Picked } from "~/helpers/types/HoppPicked"
import { getGQLSession, useGQLRequestName } from "~/newstore/GQLSession"
-import {
- getRESTRequest,
- setRESTSaveContext,
- useRESTRequestName,
-} from "~/newstore/RESTSession"
+import { useI18n } from "@composables/i18n"
+import { useToast } from "@composables/toast"
import {
editGraphqlRequest,
editRESTRequest,
@@ -91,6 +87,8 @@ import {
saveRESTRequestAs,
} from "~/newstore/collections"
import { GQLError } from "~/helpers/backend/GQLClient"
+import { computedWithControl } from "@vueuse/core"
+import { currentActiveTab } from "~/helpers/rest/tab"
const t = useI18n()
const toast = useToast()
@@ -127,8 +125,13 @@ const emit = defineEmits<{
(e: "hide-modal"): void
}>()
-const requestName = ref(
- props.mode === "rest" ? useRESTRequestName() : useGQLRequestName()
+const gqlRequestName = useGQLRequestName()
+const requestName = computedWithControl(
+ () => [currentActiveTab.value, gqlRequestName.value],
+ () =>
+ props.mode === "rest"
+ ? currentActiveTab.value.document.request.name
+ : gqlRequestName.value
)
const requestData = reactive({
@@ -186,7 +189,7 @@ const saveRequestAs = async () => {
const requestUpdated =
props.mode === "rest"
- ? cloneDeep(getRESTRequest())
+ ? cloneDeep(currentActiveTab.value.document.request)
: cloneDeep(getGQLSession().request)
if (picked.value.pickedType === "my-collection") {
@@ -198,12 +201,15 @@ const saveRequestAs = async () => {
requestUpdated
)
- setRESTSaveContext({
- originLocation: "user-collection",
- folderPath: `${picked.value.collectionIndex}`,
- requestIndex: insertionIndex,
- req: requestUpdated,
- })
+ currentActiveTab.value.document = {
+ request: requestUpdated,
+ isDirty: false,
+ saveContext: {
+ originLocation: "user-collection",
+ folderPath: `${picked.value.collectionIndex}`,
+ requestIndex: insertionIndex,
+ },
+ }
requestSaved()
} else if (picked.value.pickedType === "my-folder") {
@@ -215,12 +221,15 @@ const saveRequestAs = async () => {
requestUpdated
)
- setRESTSaveContext({
- originLocation: "user-collection",
- folderPath: picked.value.folderPath,
- requestIndex: insertionIndex,
- req: requestUpdated,
- })
+ currentActiveTab.value.document = {
+ request: requestUpdated,
+ isDirty: false,
+ saveContext: {
+ originLocation: "user-collection",
+ folderPath: picked.value.folderPath,
+ requestIndex: insertionIndex,
+ },
+ }
requestSaved()
} else if (picked.value.pickedType === "my-request") {
@@ -233,12 +242,15 @@ const saveRequestAs = async () => {
requestUpdated
)
- setRESTSaveContext({
- originLocation: "user-collection",
- folderPath: picked.value.folderPath,
- requestIndex: picked.value.requestIndex,
- req: requestUpdated,
- })
+ currentActiveTab.value.document = {
+ request: requestUpdated,
+ isDirty: false,
+ saveContext: {
+ originLocation: "user-collection",
+ folderPath: picked.value.folderPath,
+ requestIndex: picked.value.requestIndex,
+ },
+ }
requestSaved()
} else if (picked.value.pickedType === "teams-collection") {
@@ -341,13 +353,17 @@ const updateTeamCollectionOrFolder = (
(result) => {
const { createRequestInCollection } = result
- setRESTSaveContext({
- originLocation: "team-collection",
- requestID: createRequestInCollection.id,
- collectionID: createRequestInCollection.collection.id,
- teamID: createRequestInCollection.collection.team.id,
- req: requestUpdated,
- })
+ currentActiveTab.value.document = {
+ request: requestUpdated,
+ isDirty: false,
+ saveContext: {
+ originLocation: "team-collection",
+ requestID: createRequestInCollection.id,
+ collectionID: createRequestInCollection.collection.id,
+ teamID: createRequestInCollection.collection.team.id,
+ },
+ }
+
modalLoadingState.value = false
requestSaved()
}
diff --git a/packages/hoppscotch-common/src/components/collections/TeamCollections.vue b/packages/hoppscotch-common/src/components/collections/TeamCollections.vue
index c26e29607..3660c23b7 100644
--- a/packages/hoppscotch-common/src/components/collections/TeamCollections.vue
+++ b/packages/hoppscotch-common/src/components/collections/TeamCollections.vue
@@ -316,11 +316,10 @@ import { TeamRequest } from "~/helpers/teams/TeamRequest"
import { ChildrenResult, SmartTreeAdapter } from "~/helpers/treeAdapter"
import { cloneDeep } from "lodash-es"
import { HoppRESTRequest } from "@hoppscotch/data"
-import { useReadonlyStream } from "~/composables/stream"
-import { restSaveContext$ } from "~/newstore/RESTSession"
import { pipe } from "fp-ts/function"
import * as O from "fp-ts/Option"
import { Picked } from "~/helpers/types/HoppPicked.js"
+import { currentActiveTab } from "~/helpers/rest/tab"
const t = useI18n()
const colorMode = useColorMode()
@@ -520,7 +519,7 @@ const isSelected = computed(() => {
}
})
-const active = useReadonlyStream(restSaveContext$, null)
+const active = computed(() => currentActiveTab.value.document.saveContext)
const isActiveRequest = computed(() => {
return (requestID: string) => {
diff --git a/packages/hoppscotch-common/src/components/collections/index.vue b/packages/hoppscotch-common/src/components/collections/index.vue
index 02a7a1628..98ec377b7 100644
--- a/packages/hoppscotch-common/src/components/collections/index.vue
+++ b/packages/hoppscotch-common/src/components/collections/index.vue
@@ -146,18 +146,6 @@
@import-to-teams="importToTeams"
@hide-modal="displayModalImportExport(false)"
/>
- <HttpReqChangeConfirmModal
- :show="confirmChangeToRequest"
- :loading="modalLoadingState"
- @hide-modal="confirmChangeToRequest = false"
- @save-change="saveRequestChange"
- @discard-change="discardRequestChange"
- />
- <CollectionsSaveRequest
- mode="rest"
- :show="showSaveRequestModal"
- @hide-modal="showSaveRequestModal = false"
- />
<TeamsAdd
:show="showTeamModalAdd"
@hide-modal="displayTeamModalAdd(false)"
@@ -166,7 +154,7 @@
</template>
<script setup lang="ts">
-import { computed, PropType, reactive, ref, watch } from "vue"
+import { computed, PropType, ref, watch } from "vue"
import { useToast } from "@composables/toast"
import { useI18n } from "@composables/i18n"
import { Picked } from "~/helpers/types/HoppPicked"
@@ -183,7 +171,6 @@ import {
editRESTCollection,
editRESTFolder,
editRESTRequest,
- moveRESTFolder,
moveRESTRequest,
removeRESTCollection,
removeRESTFolder,
@@ -192,23 +179,14 @@ import {
saveRESTRequestAs,
updateRESTRequestOrder,
updateRESTCollectionOrder,
+ moveRESTFolder,
} from "~/newstore/collections"
import TeamCollectionAdapter from "~/helpers/teams/TeamCollectionAdapter"
import {
HoppCollection,
HoppRESTRequest,
- isEqualHoppRESTRequest,
makeCollection,
- safelyExtractRESTRequest,
- translateToNewRequest,
} from "@hoppscotch/data"
-import {
- getDefaultRESTRequest,
- getRESTRequest,
- getRESTSaveContext,
- setRESTRequest,
- setRESTSaveContext,
-} from "~/newstore/RESTSession"
import { cloneDeep, isEqual } from "lodash-es"
import { GQLError } from "~/helpers/backend/GQLClient"
import {
@@ -234,12 +212,26 @@ import {
getTeamCollectionJSON,
teamCollToHoppRESTColl,
} from "~/helpers/backend/helpers"
-import { HoppRequestSaveContext } from "~/helpers/types/HoppRequestSaveContext"
import * as E from "fp-ts/Either"
import { platform } from "~/platform"
import { createCollectionGists } from "~/helpers/gist"
import { workspaceStatus$ } from "~/newstore/workspace"
import IconListEnd from "~icons/lucide/list-end"
+import {
+ createNewTab,
+ currentActiveTab,
+ currentTabID,
+ getTabRefWithSaveContext,
+} from "~/helpers/rest/tab"
+import {
+ getRequestsByPath,
+ resolveSaveContextOnRequestReorder,
+} from "~/helpers/collection/request"
+import {
+ getFoldersByPath,
+ resolveSaveContextOnCollectionReorder,
+ updateSaveContextForAffectedRequests,
+} from "~/helpers/collection/collection"
const t = useI18n()
const toast = useToast()
@@ -314,15 +306,6 @@ const exportingTeamCollections = ref(false)
const creatingGistCollection = ref(false)
const importingMyCollections = ref(false)
-// Confirm Change to request modal
-const confirmChangeToRequest = ref(false)
-const showSaveRequestModal = ref(false)
-const clickedRequest = reactive({
- folderPath: "" as string | undefined,
- requestIndex: null as string | null,
- request: null as HoppRESTRequest | null,
-})
-
// TeamList-Adapter
const teamListAdapter = new TeamListAdapter(true)
const myTeams = useReadonlyStream(teamListAdapter.teamList$, null)
@@ -637,7 +620,7 @@ const addRequest = (payload: {
const onAddRequest = (requestName: string) => {
const newRequest = {
- ...cloneDeep(getRESTRequest()),
+ ...cloneDeep(currentActiveTab.value.document.request),
name: requestName,
}
@@ -646,10 +629,14 @@ const onAddRequest = (requestName: string) => {
if (!path) return
const insertionIndex = saveRESTRequestAs(path, newRequest)
- setRESTRequest(newRequest, {
- originLocation: "user-collection",
- folderPath: path,
- requestIndex: insertionIndex,
+ createNewTab({
+ request: newRequest,
+ isDirty: false,
+ saveContext: {
+ originLocation: "user-collection",
+ folderPath: path,
+ requestIndex: insertionIndex,
+ },
})
displayModalAddRequest(false)
@@ -677,12 +664,17 @@ const onAddRequest = (requestName: string) => {
(result) => {
const { createRequestInCollection } = result
- setRESTRequest(newRequest, {
- originLocation: "team-collection",
- requestID: createRequestInCollection.id,
- collectionID: createRequestInCollection.collection.id,
- teamID: createRequestInCollection.collection.team.id,
+ createNewTab({
+ request: newRequest,
+ isDirty: false,
+ saveContext: {
+ originLocation: "team-collection",
+ requestID: createRequestInCollection.id,
+ collectionID: createRequestInCollection.collection.id,
+ teamID: createRequestInCollection.collection.team.id,
+ },
})
+
modalLoadingState.value = false
displayModalAddRequest(false)
}
@@ -873,27 +865,22 @@ const updateEditingRequest = (newName: string) => {
...request,
name: newName || request.name,
}
-
- const saveCtx = getRESTSaveContext()
-
if (collectionsType.value.type === "my-collections") {
const folderPath = editingFolderPath.value
const requestIndex = editingRequestIndex.value
if (folderPath === null || requestIndex === null) return
+ const possibleActiveTab = getTabRefWithSaveContext({
+ originLocation: "user-collection",
+ requestIndex,
+ folderPath,
+ })
+
editRESTRequest(folderPath, requestIndex, requestUpdated)
- if (
- saveCtx &&
- saveCtx.originLocation === "user-collection" &&
- saveCtx.requestIndex === editingRequestIndex.value &&
- saveCtx.folderPath === editingFolderPath.value
- ) {
- setRESTRequest({
- ...getRESTRequest(),
- name: requestUpdated.name,
- })
+ if (possibleActiveTab) {
+ possibleActiveTab.value.document.request.name = requestUpdated.name
}
displayModalEditRequest(false)
@@ -925,15 +912,13 @@ const updateEditingRequest = (newName: string) => {
)
)()
- if (
- saveCtx &&
- saveCtx.originLocation === "team-collection" &&
- saveCtx.requestID === editingRequestID.value
- ) {
- setRESTRequest({
- ...getRESTRequest(),
- name: requestName,
- })
+ const possibleTab = getTabRefWithSaveContext({
+ originLocation: "team-collection",
+ requestID,
+ })
+
+ if (possibleTab) {
+ possibleTab.value.document.request.name = requestName
}
}
}
@@ -1030,6 +1015,13 @@ const onRemoveCollection = () => {
removeRESTCollection(collectionIndex)
+ resolveSaveContextOnCollectionReorder({
+ lastIndex: collectionIndex,
+ newIndex: -1,
+ folderPath: "", // root folder
+ length: myCollections.value.length,
+ })
+
toast.success(t("state.deleted"))
displayConfirmModal(false)
} else if (hasTeamWriteAccess.value) {
@@ -1074,6 +1066,14 @@ const onRemoveFolder = () => {
removeRESTFolder(folderPath)
+ const parentFolder = folderPath.split("/").slice(0, -1).join("/") // remove last folder to get parent folder
+ resolveSaveContextOnCollectionReorder({
+ lastIndex: pathToLastIndex(folderPath),
+ newIndex: -1,
+ folderPath: parentFolder,
+ length: getFoldersByPath(myCollections.value, parentFolder).length,
+ })
+
toast.success(t("state.deleted"))
displayConfirmModal(false)
} else if (hasTeamWriteAccess.value) {
@@ -1124,8 +1124,28 @@ const onRemoveRequest = () => {
emit("select", null)
}
+ const possibleTab = getTabRefWithSaveContext({
+ originLocation: "user-collection",
+ folderPath,
+ requestIndex,
+ })
+
+ // If there is a tab attached to this request, dissociate its state and mark it dirty
+ if (possibleTab) {
+ possibleTab.value.document.saveContext = null
+ possibleTab.value.document.isDirty = true
+ }
+
removeRESTRequest(folderPath, requestIndex)
+ // the same function is used to reorder requests since after removing, it's basically doing reorder
+ resolveSaveContextOnRequestReorder({
+ lastIndex: requestIndex,
+ newIndex: -1,
+ folderPath,
+ length: getRequestsByPath(myCollections.value, folderPath).length,
+ })
+
toast.success(t("state.deleted"))
displayConfirmModal(false)
} else if (hasTeamWriteAccess.value) {
@@ -1157,6 +1177,17 @@ const onRemoveRequest = () => {
}
)
)()
+
+ // If there is a tab attached to this request, dissociate its state and mark it dirty
+ const possibleTab = getTabRefWithSaveContext({
+ originLocation: "team-collection",
+ requestID,
+ })
+
+ if (possibleTab) {
+ possibleTab.value.document.saveContext = undefined
+ possibleTab.value.document.isDirty = true
+ }
}
}
@@ -1165,41 +1196,6 @@ const selectPicked = (payload: Picked | null) => {
emit("select", payload)
}
-// select request change modal functions
-const noChangeSetRESTRequest = () => {
- const folderPath = clickedRequest.folderPath
- const requestIndex = clickedRequest.requestIndex
- const request = clickedRequest.request
-
- let newContext: HoppRequestSaveContext | null = null
- if (collectionsType.value.type === "my-collections") {
- if (!folderPath || !requestIndex || !request) return
-
- newContext = {
- originLocation: "user-collection",
- requestIndex: parseInt(requestIndex),
- folderPath,
- req: cloneDeep(request),
- }
- } else if (collectionsType.value.type === "team-collections") {
- if (!requestIndex || !request) return
- newContext = {
- originLocation: "team-collection",
- requestID: requestIndex,
- req: cloneDeep(request),
- }
- }
- setRESTRequest(
- cloneDeep(
- safelyExtractRESTRequest(
- translateToNewRequest(request),
- getDefaultRESTRequest()
- )
- ),
- newContext
- )
-}
-
/**
* This function is called when the user clicks on a request
* @param selectedRequest The request that the user clicked on emited from the collection tree
@@ -1210,131 +1206,51 @@ const selectRequest = (selectedRequest: {
requestIndex: string
isActive: boolean
}) => {
- const { request, folderPath, requestIndex, isActive } = selectedRequest
- // If the request is already active, then we reset the save context
- if (isActive) {
- setRESTSaveContext(null)
- return
- }
+ const { request, folderPath, requestIndex } = selectedRequest
- const currentRESTRequest = getRESTRequest()
+ // If there is a request with this save context, switch into it
+ let possibleTab = null
- const currentRESTSaveContext = getRESTSaveContext()
-
- clickedRequest.folderPath = folderPath
- clickedRequest.requestIndex = requestIndex
- clickedRequest.request = request
-
- // If there is no active context,
- if (!currentRESTSaveContext) {
- // Check if the use is clicking on the same request
- if (isEqualHoppRESTRequest(currentRESTRequest, request)) {
- noChangeSetRESTRequest()
+ if (collectionsType.value.type === "team-collections") {
+ possibleTab = getTabRefWithSaveContext({
+ originLocation: "team-collection",
+ requestID: requestIndex,
+ })
+ if (possibleTab) {
+ currentTabID.value = possibleTab.value.id
} else {
- // can show the save change modal here since there is change in the request
- // and the user is clicking on the different request
- // and currently we dont have any active context
-
- confirmChangeToRequest.value = true
+ createNewTab({
+ request: cloneDeep(request),
+ isDirty: false,
+ saveContext: {
+ originLocation: "team-collection",
+ requestID: requestIndex,
+ },
+ })
}
} else {
- if (isEqualHoppRESTRequest(currentRESTRequest, request)) {
- noChangeSetRESTRequest()
+ possibleTab = getTabRefWithSaveContext({
+ originLocation: "user-collection",
+ requestIndex: parseInt(requestIndex),
+ folderPath: folderPath!,
+ })
+ if (possibleTab) {
+ currentTabID.value = possibleTab.value.id
} else {
- const currentReqWithNoChange = currentRESTSaveContext.req
- // now we compare the current request
- // with the request inside the active context
- if (
- currentReqWithNoChange &&
- isEqualHoppRESTRequest(currentReqWithNoChange, currentRESTRequest)
- ) {
- noChangeSetRESTRequest()
- } else {
- // there is change in the request
- // so we can show the save change modal here
- confirmChangeToRequest.value = true
- }
- }
- }
-}
-
-/**
- * This function is called when the user clicks on the save button in the confirm change modal
- * There are two cases
- * 1. There is no active context
- * 2. There is active context
- * In the first case, we can show the save request as modal and user can select the location to save the request
- * In the second case, we can save the request in the same location and update the request
- */
-const saveRequestChange = () => {
- const currentRESTSaveContext = getRESTSaveContext()
-
- if (!currentRESTSaveContext) {
- showSaveRequestModal.value = true
- confirmChangeToRequest.value = false
- return
- }
-
- const currentRESTRequest = getRESTRequest()
-
- if (currentRESTSaveContext.originLocation === "user-collection") {
- const folderPath = currentRESTSaveContext.folderPath
- const requestIndex = currentRESTSaveContext.requestIndex
-
- editRESTRequest(folderPath, requestIndex, currentRESTRequest)
-
- // after saving the request, we need to change the context
- // to the new request (clicked request)
- noChangeSetRESTRequest()
-
- toast.success(`${t("request.saved")}`)
- confirmChangeToRequest.value = false
- } else {
- modalLoadingState.value = true
-
- const requestID = currentRESTSaveContext.requestID
-
- const data = {
- request: JSON.stringify(currentRESTRequest),
- title: currentRESTRequest.name,
- }
-
- pipe(
- updateTeamRequest(requestID, data),
- TE.match(
- (err: GQLError<string>) => {
- toast.error(`${getErrorMessage(err)}`)
- confirmChangeToRequest.value = false
- showSaveRequestModal.value = true
- modalLoadingState.value = false
+ // If not, open the request in a new tab
+ createNewTab({
+ request: cloneDeep(request),
+ isDirty: false,
+ saveContext: {
+ originLocation: "user-collection",
+ folderPath: folderPath!,
+ requestIndex: parseInt(requestIndex),
},
- () => {
- toast.success(`${t("request.saved")}`)
- modalLoadingState.value = false
- confirmChangeToRequest.value = false
-
- const clickedRequestID = clickedRequest.requestIndex
-
- if (!clickedRequestID) return
-
- noChangeSetRESTRequest()
- }
- )
- )()
+ })
+ }
}
}
-/**
- * This function is called when the user clicks on the
- * don't save button in the confirm change modal
- * This function will change the request to the clicked request
- * without saving the changes
- */
-const discardRequestChange = () => {
- noChangeSetRESTRequest()
- confirmChangeToRequest.value = false
-}
-
/**
* Used to get the index of the request from the path
* @param path The path of the request
@@ -1355,13 +1271,42 @@ const dropRequest = (payload: {
destinationCollectionIndex: string
}) => {
const { folderPath, requestIndex, destinationCollectionIndex } = payload
+
if (!requestIndex || !destinationCollectionIndex) return
+
if (collectionsType.value.type === "my-collections" && folderPath) {
moveRESTRequest(
folderPath,
pathToLastIndex(requestIndex),
destinationCollectionIndex
)
+
+ const possibleTab = getTabRefWithSaveContext({
+ originLocation: "user-collection",
+ folderPath,
+ requestIndex: pathToLastIndex(requestIndex),
+ })
+
+ // If there is a tab attached to this request, change save its save context
+ if (possibleTab) {
+ possibleTab.value.document.saveContext = {
+ originLocation: "user-collection",
+ folderPath: destinationCollectionIndex,
+ requestIndex: getRequestsByPath(
+ myCollections.value,
+ destinationCollectionIndex
+ ).length,
+ }
+ }
+
+ // When it's drop it's basically getting deleted from last folder. reordering last folder accordingly
+ resolveSaveContextOnRequestReorder({
+ lastIndex: pathToLastIndex(requestIndex),
+ newIndex: -1, // being deleted from last folder
+ folderPath,
+ length: getRequestsByPath(myCollections.value, folderPath).length,
+ })
+
toast.success(`${t("request.moved")}`)
draggingToRoot.value = false
} else if (hasTeamWriteAccess.value) {
@@ -1384,6 +1329,18 @@ const dropRequest = (payload: {
requestMoveLoading.value.indexOf(requestIndex),
1
)
+
+ const possibleTab = getTabRefWithSaveContext({
+ originLocation: "team-collection",
+ requestID: requestIndex,
+ })
+
+ if (possibleTab) {
+ possibleTab.value.document.saveContext = {
+ originLocation: "team-collection",
+ requestID: requestIndex,
+ }
+ }
toast.success(`${t("request.moved")}`)
}
)
@@ -1440,6 +1397,7 @@ const dropCollection = (payload: {
const { collectionIndexDragged, destinationCollectionIndex } = payload
if (!collectionIndexDragged || !destinationCollectionIndex) return
if (collectionIndexDragged === destinationCollectionIndex) return
+
if (collectionsType.value.type === "my-collections") {
if (
checkIfCollectionIsAParentOfTheChildren(
@@ -1450,7 +1408,32 @@ const dropCollection = (payload: {
toast.error(`${t("team.parent_coll_move")}`)
return
}
+
+ const parentFolder = collectionIndexDragged
+ .split("/")
+ .slice(0, -1)
+ .join("/") // remove last folder to get parent folder
+ const totalFoldersOfDestinationCollection =
+ getFoldersByPath(myCollections.value, destinationCollectionIndex).length -
+ (parentFolder === destinationCollectionIndex ? 1 : 0)
+
moveRESTFolder(collectionIndexDragged, destinationCollectionIndex)
+
+ resolveSaveContextOnCollectionReorder(
+ {
+ lastIndex: pathToLastIndex(collectionIndexDragged),
+ newIndex: -1,
+ folderPath: parentFolder,
+ length: getFoldersByPath(myCollections.value, parentFolder).length,
+ },
+ "drop"
+ )
+
+ updateSaveContextForAffectedRequests(
+ collectionIndexDragged,
+ `${destinationCollectionIndex}/${totalFoldersOfDestinationCollection}`
+ )
+
draggingToRoot.value = false
toast.success(`${t("collection.moved")}`)
} else if (hasTeamWriteAccess.value) {
@@ -1600,6 +1583,11 @@ const updateRequestOrder = (payload: {
pathToLastIndex(destinationRequestIndex),
destinationCollectionIndex
)
+ resolveSaveContextOnRequestReorder({
+ lastIndex: pathToLastIndex(dragedRequestIndex),
+ newIndex: pathToLastIndex(destinationRequestIndex),
+ folderPath: destinationCollectionIndex,
+ })
toast.success(`${t("request.order_changed")}`)
}
} else if (hasTeamWriteAccess.value) {
@@ -1654,6 +1642,11 @@ const updateCollectionOrder = (payload: {
dragedCollectionIndex,
destinationCollectionIndex
)
+ resolveSaveContextOnCollectionReorder({
+ lastIndex: pathToLastIndex(dragedCollectionIndex),
+ newIndex: pathToLastIndex(destinationCollectionIndex),
+ folderPath: dragedCollectionIndex.split("/").slice(0, -1).join("/"),
+ })
toast.success(`${t("collection.order_changed")}`)
}
} else if (hasTeamWriteAccess.value) {
diff --git a/packages/hoppscotch-common/src/components/history/index.vue b/packages/hoppscotch-common/src/components/history/index.vue
index 35a3a173a..96358f117 100644
--- a/packages/hoppscotch-common/src/components/history/index.vue
+++ b/packages/hoppscotch-common/src/components/history/index.vue
@@ -148,17 +148,6 @@
@hide-modal="confirmRemove = false"
@resolve="clearHistory"
/>
- <HttpReqChangeConfirmModal
- :show="confirmChange"
- @hide-modal="confirmChange = false"
- @save-change="saveRequestChange"
- @discard-change="discardRequestChange"
- />
- <CollectionsSaveRequest
- mode="rest"
- :show="showSaveRequestModal"
- @hide-modal="showSaveRequestModal = false"
- />
</div>
</template>
@@ -169,17 +158,11 @@ import IconTrash from "~icons/lucide/trash"
import IconFilter from "~icons/lucide/filter"
import { computed, ref, Ref, toRaw } from "vue"
import { useColorMode } from "@composables/theming"
-import {
- HoppGQLRequest,
- HoppRESTRequest,
- isEqualHoppRESTRequest,
- safelyExtractRESTRequest,
-} from "@hoppscotch/data"
+import { HoppGQLRequest, HoppRESTRequest } from "@hoppscotch/data"
import { groupBy, escapeRegExp, filter } from "lodash-es"
import { useTimeAgo } from "@vueuse/core"
import { pipe } from "fp-ts/function"
import * as A from "fp-ts/Array"
-import * as E from "fp-ts/Either"
import { useI18n } from "@composables/i18n"
import { useReadonlyStream } from "@composables/stream"
import { useToast } from "@composables/toast"
@@ -195,20 +178,10 @@ import {
RESTHistoryEntry,
GQLHistoryEntry,
} from "~/newstore/history"
-import {
- getDefaultRESTRequest,
- getRESTRequest,
- getRESTSaveContext,
- setRESTRequest,
- setRESTSaveContext,
-} from "~/newstore/RESTSession"
-import { editRESTRequest } from "~/newstore/collections"
-import { runMutation } from "~/helpers/backend/GQLClient"
-import { UpdateRequestDocument } from "~/helpers/backend/graphql"
-import { HoppRequestSaveContext } from "~/helpers/types/HoppRequestSaveContext"
import HistoryRestCard from "./rest/Card.vue"
import HistoryGraphqlCard from "./graphql/Card.vue"
+import { createNewTab } from "~/helpers/rest/tab"
type HistoryEntry = GQLHistoryEntry | RESTHistoryEntry
@@ -229,10 +202,6 @@ const filterText = ref("")
const showMore = ref(false)
const confirmRemove = ref(false)
-const clickedHistory = ref<HistoryEntry | null>(null)
-const confirmChange = ref(false)
-const showSaveRequestModal = ref(false)
-
const history = useReadonlyStream<RESTHistoryEntry[] | GQLHistoryEntry[]>(
props.page === "rest" ? restHistory$ : graphqlHistory$,
[]
@@ -326,111 +295,13 @@ const clearHistory = () => {
toast.success(`${t("state.history_deleted")}`)
}
-const setRestReq = (request: HoppRESTRequest | null | undefined) => {
- setRESTRequest(safelyExtractRESTRequest(request, getDefaultRESTRequest()))
-}
-
// NOTE: For GQL, the HistoryGraphqlCard component already implements useEntry
// (That is not a really good behaviour tho ¯\_(ツ)_/¯)
const useHistory = (entry: RESTHistoryEntry) => {
- const currentFullReq = getRESTRequest()
-
- const currentReqWithNoChange = getRESTSaveContext()?.req
-
- // checks if the current request is the same as the save context request if present
- if (
- currentReqWithNoChange &&
- isEqualHoppRESTRequest(currentReqWithNoChange, currentFullReq)
- ) {
- props.page === "rest" && setRestReq(entry.request)
- clickedHistory.value = entry
- }
- // Initial state trigers a popup
- else if (!clickedHistory.value) {
- clickedHistory.value = entry
- confirmChange.value = true
- return
- }
- // Checks if there are any change done in current request and the history request
- else if (
- !isEqualHoppRESTRequest(
- currentFullReq,
- clickedHistory.value.request as HoppRESTRequest
- )
- ) {
- clickedHistory.value = entry
- confirmChange.value = true
- } else {
- props.page === "rest" && setRestReq(entry.request)
- clickedHistory.value = entry
- }
-}
-
-/** Save current request to the collection */
-const saveRequestChange = () => {
- const saveCtx = getRESTSaveContext()
- saveCurrentRequest(saveCtx)
- confirmChange.value = false
-}
-
-/** Discard changes and change the current request and remove the collection context */
-const discardRequestChange = () => {
- const saveCtx = getRESTSaveContext()
- if (saveCtx) {
- setRESTSaveContext(null)
- }
- clickedHistory.value &&
- setRestReq(clickedHistory.value.request as HoppRESTRequest)
- confirmChange.value = false
-}
-
-const saveCurrentRequest = (saveCtx: HoppRequestSaveContext | null) => {
- if (!saveCtx) {
- showSaveRequestModal.value = true
- return
- }
- if (saveCtx.originLocation === "user-collection") {
- try {
- editRESTRequest(
- saveCtx.folderPath,
- saveCtx.requestIndex,
- getRESTRequest()
- )
- clickedHistory.value &&
- setRestReq(clickedHistory.value.request as HoppRESTRequest)
- setRESTSaveContext(null)
- toast.success(`${t("request.saved")}`)
- } catch (e) {
- console.error(e)
- setRESTSaveContext(null)
- saveCurrentRequest(null)
- }
- } else if (saveCtx.originLocation === "team-collection") {
- const req = getRESTRequest()
- try {
- runMutation(UpdateRequestDocument, {
- requestID: saveCtx.requestID,
- data: {
- title: req.name,
- request: JSON.stringify(req),
- },
- })().then((result) => {
- if (E.isLeft(result)) {
- toast.error(`${t("profile.no_permission")}`)
- } else {
- toast.success(`${t("request.saved")}`)
- }
- })
- clickedHistory.value &&
- setRestReq(clickedHistory.value.request as HoppRESTRequest)
- setRESTSaveContext(null)
- } catch (error) {
- showSaveRequestModal.value = true
- toast.error(`${t("error.something_went_wrong")}`)
- console.error(error)
- setRESTSaveContext(null)
- }
- }
+ createNewTab({
+ request: entry.request,
+ isDirty: false,
+ })
}
const isRESTHistoryEntry = (
diff --git a/packages/hoppscotch-common/src/components/http/Authorization.vue b/packages/hoppscotch-common/src/components/http/Authorization.vue
index c8fda1553..32113c7c7 100644
--- a/packages/hoppscotch-common/src/components/http/Authorization.vue
+++ b/packages/hoppscotch-common/src/components/http/Authorization.vue
@@ -32,7 +32,7 @@
:active="authName === 'None'"
@click="
() => {
- authType = 'none'
+ auth.authType = 'none'
hide()
}
"
@@ -43,7 +43,7 @@
:active="authName === 'Basic Auth'"
@click="
() => {
- authType = 'basic'
+ auth.authType = 'basic'
hide()
}
"
@@ -54,7 +54,7 @@
:active="authName === 'Bearer'"
@click="
() => {
- authType = 'bearer'
+ auth.authType = 'bearer'
hide()
}
"
@@ -65,7 +65,7 @@
:active="authName === 'OAuth 2.0'"
@click="
() => {
- authType = 'oauth-2'
+ auth.authType = 'oauth-2'
hide()
}
"
@@ -76,7 +76,7 @@
:active="authName === 'API key'"
@click="
() => {
- authType = 'api-key'
+ auth.authType = 'api-key'
hide()
}
"
@@ -114,7 +114,7 @@
</div>
</div>
<div
- v-if="authType === 'none'"
+ v-if="auth.authType === 'none'"
class="flex flex-col items-center justify-center p-4 text-secondaryLight"
>
<img
@@ -136,91 +136,22 @@
</div>
<div v-else class="flex flex-1 border-b border-dividerLight">
<div class="w-2/3 border-r border-dividerLight">
- <div v-if="authType === 'basic'">
- <div class="flex flex-1 border-b border-dividerLight">
- <SmartEnvInput
- v-model="basicUsername"
- :placeholder="t('authorization.username')"
- />
- </div>
- <div class="flex flex-1 border-b border-dividerLight">
- <SmartEnvInput
- v-model="basicPassword"
- :placeholder="t('authorization.password')"
- />
- </div>
+ <div v-if="auth.authType === 'basic'">
+ <HttpAuthorizationBasic v-model="auth" />
</div>
- <div v-if="authType === 'bearer'">
+ <div v-if="auth.authType === 'bearer'">
<div class="flex flex-1 border-b border-dividerLight">
- <SmartEnvInput v-model="bearerToken" placeholder="Token" />
+ <SmartEnvInput v-model="auth.token" placeholder="Token" />
</div>
</div>
- <div v-if="authType === 'oauth-2'">
+ <div v-if="auth.authType === 'oauth-2'">
<div class="flex flex-1 border-b border-dividerLight">
- <SmartEnvInput v-model="oauth2Token" placeholder="Token" />
+ <SmartEnvInput v-model="auth.token" placeholder="Token" />
</div>
- <HttpOAuth2Authorization />
+ <HttpOAuth2Authorization v-model="auth" />
</div>
- <div v-if="authType === 'api-key'">
- <div class="flex flex-1 border-b border-dividerLight">
- <SmartEnvInput v-model="apiKey" placeholder="Key" />
- </div>
- <div class="flex flex-1 border-b border-dividerLight">
- <SmartEnvInput v-model="apiValue" placeholder="Value" />
- </div>
- <div class="flex items-center border-b border-dividerLight">
- <span class="flex items-center">
- <label class="ml-4 text-secondaryLight">
- {{ t("authorization.pass_key_by") }}
- </label>
- <tippy
- interactive
- trigger="click"
- theme="popover"
- :on-shown="() => authTippyActions.focus()"
- >
- <span class="select-wrapper">
- <HoppButtonSecondary
- :label="addTo || t('state.none')"
- class="pr-8 ml-2 rounded-none"
- />
- </span>
- <template #content="{ hide }">
- <div
- ref="authTippyActions"
- class="flex flex-col focus:outline-none"
- tabindex="0"
- @keyup.escape="hide()"
- >
- <HoppSmartItem
- :icon="addTo === 'Headers' ? IconCircleDot : IconCircle"
- :active="addTo === 'Headers'"
- :label="'Headers'"
- @click="
- () => {
- addTo = 'Headers'
- hide()
- }
- "
- />
- <HoppSmartItem
- :icon="
- addTo === 'Query params' ? IconCircleDot : IconCircle
- "
- :active="addTo === 'Query params'"
- :label="'Query params'"
- @click="
- () => {
- addTo = 'Query params'
- hide()
- }
- "
- />
- </div>
- </template>
- </tippy>
- </span>
- </div>
+ <div v-if="auth.authType === 'api-key'">
+ <HttpAuthorizationApiKey v-model="auth" />
</div>
</div>
<div
@@ -248,49 +179,40 @@ import IconTrash2 from "~icons/lucide/trash-2"
import IconExternalLink from "~icons/lucide/external-link"
import IconCircleDot from "~icons/lucide/circle-dot"
import IconCircle from "~icons/lucide/circle"
-import { computed, ref, Ref } from "vue"
-import {
- HoppRESTAuthBasic,
- HoppRESTAuthBearer,
- HoppRESTAuthOAuth2,
- HoppRESTAuthAPIKey,
-} from "@hoppscotch/data"
+import { computed, ref } from "vue"
+import { HoppRESTAuth } from "@hoppscotch/data"
import { pluckRef } from "@composables/ref"
-import { useStream } from "@composables/stream"
import { useI18n } from "@composables/i18n"
import { useColorMode } from "@composables/theming"
-import { restAuth$, setRESTAuth } from "~/newstore/RESTSession"
+import { useVModel } from "@vueuse/core"
const t = useI18n()
const colorMode = useColorMode()
-const auth = useStream(
- restAuth$,
- { authType: "none", authActive: true },
- setRESTAuth
-)
+const props = defineProps<{
+ modelValue: HoppRESTAuth
+}>()
+
+const emit = defineEmits<{
+ (e: "update:modelValue", value: HoppRESTAuth): void
+}>()
+
+const auth = useVModel(props, "modelValue", emit)
+
+const AUTH_KEY_NAME = {
+ basic: "Basic Auth",
+ bearer: "Bearer",
+ "oauth-2": "OAuth 2.0",
+ "api-key": "API key",
+ none: "None",
+} as const
+
const authType = pluckRef(auth, "authType")
-const authName = computed(() => {
- if (authType.value === "basic") return "Basic Auth"
- else if (authType.value === "bearer") return "Bearer"
- else if (authType.value === "oauth-2") return "OAuth 2.0"
- else if (authType.value === "api-key") return "API key"
- else return "None"
-})
+const authName = computed(() =>
+ AUTH_KEY_NAME[authType.value] ? AUTH_KEY_NAME[authType.value] : "None"
+)
const authActive = pluckRef(auth, "authActive")
-const basicUsername = pluckRef(auth as Ref<HoppRESTAuthBasic>, "username")
-const basicPassword = pluckRef(auth as Ref<HoppRESTAuthBasic>, "password")
-const bearerToken = pluckRef(auth as Ref<HoppRESTAuthBearer>, "token")
-const oauth2Token = pluckRef(auth as Ref<HoppRESTAuthOAuth2>, "token")
-const apiKey = pluckRef(auth as Ref<HoppRESTAuthAPIKey>, "key")
-const apiValue = pluckRef(auth as Ref<HoppRESTAuthAPIKey>, "value")
-const addTo = pluckRef(auth as Ref<HoppRESTAuthAPIKey>, "addTo")
-if (typeof addTo.value === "undefined") {
- addTo.value = "Headers"
- apiKey.value = ""
- apiValue.value = ""
-}
const clearContent = () => {
auth.value = {
@@ -301,5 +223,4 @@ const clearContent = () => {
// Template refs
const tippyActions = ref<any | null>(null)
-const authTippyActions = ref<any | null>(null)
</script>
diff --git a/packages/hoppscotch-common/src/components/http/Body.vue b/packages/hoppscotch-common/src/components/http/Body.vue
index 66a383df9..a592f3f5c 100644
--- a/packages/hoppscotch-common/src/components/http/Body.vue
+++ b/packages/hoppscotch-common/src/components/http/Body.vue
@@ -15,7 +15,7 @@
>
<span class="select-wrapper">
<HoppButtonSecondary
- :label="contentType || t('state.none')"
+ :label="body.contentType || t('state.none')"
class="pr-8 ml-2 rounded-none"
/>
</span>
@@ -28,11 +28,11 @@
>
<HoppSmartItem
:label="t('state.none')"
- :info-icon="contentType === null ? IconDone : null"
- :active-info-icon="contentType === null"
+ :info-icon="(body.contentType === null ? IconDone : null) as any"
+ :active-info-icon="body.contentType === null"
@click="
() => {
- contentType = null
+ body.contentType = null
hide()
}
"
@@ -57,12 +57,12 @@
:key="`contentTypeItem-${contentTypeIndex}`"
:label="contentTypeItem"
:info-icon="
- contentTypeItem === contentType ? IconDone : null
+ contentTypeItem === body.contentType ? IconDone : null
"
- :active-info-icon="contentTypeItem === contentType"
+ :active-info-icon="contentTypeItem === body.contentType"
@click="
() => {
- contentType = contentTypeItem
+ body.contentType = contentTypeItem
hide()
}
"
@@ -93,13 +93,17 @@
/>
</span>
</div>
- <HttpBodyParameters v-if="contentType === 'multipart/form-data'" />
+ <HttpBodyParameters
+ v-if="body.contentType === 'multipart/form-data'"
+ v-model="body"
+ />
<HttpURLEncodedParams
- v-else-if="contentType === 'application/x-www-form-urlencoded'"
+ v-else-if="body.contentType === 'application/x-www-form-urlencoded'"
+ v-model="body"
/>
- <HttpRawBody v-else-if="contentType !== null" :content-type="contentType" />
+ <HttpRawBody v-else-if="body.contentType !== null" v-model="body" />
<div
- v-if="contentType == null"
+ v-if="body.contentType == null"
class="flex flex-col items-center justify-center p-4 text-secondaryLight"
>
<img
@@ -123,38 +127,37 @@
</template>
<script setup lang="ts">
+import { useI18n } from "@composables/i18n"
+import { useColorMode } from "@composables/theming"
+import { HoppRESTHeader, HoppRESTReqBody } from "@hoppscotch/data"
+import { useVModel } from "@vueuse/core"
+import * as A from "fp-ts/Array"
+import { pipe } from "fp-ts/function"
+import * as O from "fp-ts/Option"
+import { computed, ref } from "vue"
+import { segmentedContentTypes } from "~/helpers/utils/contenttypes"
import IconDone from "~icons/lucide/check"
+import IconExternalLink from "~icons/lucide/external-link"
import IconInfo from "~icons/lucide/info"
import IconRefreshCW from "~icons/lucide/refresh-cw"
-import IconExternalLink from "~icons/lucide/external-link"
-import { computed, ref } from "vue"
-import { pipe } from "fp-ts/function"
-import * as A from "fp-ts/Array"
-import * as O from "fp-ts/Option"
import { RequestOptionTabs } from "./RequestOptions.vue"
-import { useStream } from "@composables/stream"
-import { useI18n } from "@composables/i18n"
-import { useColorMode } from "@composables/theming"
-import { segmentedContentTypes } from "~/helpers/utils/contenttypes"
-import {
- restContentType$,
- restHeaders$,
- setRESTContentType,
- setRESTHeaders,
- addRESTHeader,
-} from "~/newstore/RESTSession"
const colorMode = useColorMode()
const t = useI18n()
-const emit = defineEmits<{
- (e: "change-tab", value: string): void
+const props = defineProps<{
+ body: HoppRESTReqBody
+ headers: HoppRESTHeader[]
}>()
-const contentType = useStream(restContentType$, null, setRESTContentType)
+const emit = defineEmits<{
+ (e: "change-tab", value: RequestOptionTabs): void
+ (e: "update:headers", value: HoppRESTHeader[]): void
+ (e: "update:body", value: HoppRESTReqBody): void
+}>()
-// The functional headers list (the headers actually in the system)
-const headers = useStream(restHeaders$, [], setRESTHeaders)
+const headers = useVModel(props, "headers", emit)
+const body = useVModel(props, "body", emit)
const overridenContentType = computed(() =>
pipe(
@@ -168,7 +171,9 @@ const overridenContentType = computed(() =>
const contentTypeOverride = (tab: RequestOptionTabs) => {
emit("change-tab", tab)
if (!isContentTypeAlreadyExist()) {
- addRESTHeader({
+ // TODO: Fix this
+
+ headers.value.push({
key: "Content-Type",
value: "",
active: true,
diff --git a/packages/hoppscotch-common/src/components/http/BodyParameters.vue b/packages/hoppscotch-common/src/components/http/BodyParameters.vue
index 1fc20e3fe..2bdf6512d 100644
--- a/packages/hoppscotch-common/src/components/http/BodyParameters.vue
+++ b/packages/hoppscotch-common/src/components/http/BodyParameters.vue
@@ -186,14 +186,26 @@ import { ref, watch } from "vue"
import { flow, pipe } from "fp-ts/function"
import * as O from "fp-ts/Option"
import * as A from "fp-ts/Array"
-import { FormDataKeyValue } from "@hoppscotch/data"
+import { FormDataKeyValue, HoppRESTReqBody } from "@hoppscotch/data"
import { isEqual, clone } from "lodash-es"
import draggable from "vuedraggable-es"
import { pluckRef } from "@composables/ref"
import { useI18n } from "@composables/i18n"
import { useToast } from "@composables/toast"
import { useColorMode } from "@composables/theming"
-import { useRESTRequestBody } from "~/newstore/RESTSession"
+import { useVModel } from "@vueuse/core"
+
+type Body = HoppRESTReqBody & { contentType: "multipart/form-data" }
+
+const props = defineProps<{
+ modelValue: Body
+}>()
+
+const emit = defineEmits<{
+ (e: "update:modelValue", val: Body): void
+}>()
+
+const body = useVModel(props, "modelValue", emit)
type WorkingFormDataKeyValue = { id: number; entry: FormDataKeyValue }
@@ -206,7 +218,7 @@ const idTicker = ref(0)
const deletionToast = ref<{ goAway: (delay: number) => void } | null>(null)
-const bodyParams = pluckRef<any, any>(useRESTRequestBody(), "body")
+const bodyParams = pluckRef(body, "body")
// The UI representation of the parameters list (has the empty end param)
const workingParams = ref<WorkingFormDataKeyValue[]>([
@@ -355,7 +367,7 @@ const clearContent = () => {
const setRequestAttachment = (
index: number,
entry: FormDataKeyValue,
- event: InputEvent
+ event: InputEvent | Event
) => {
// check if file exists or not
if ((event.target as HTMLInputElement).files?.length === 0) {
diff --git a/packages/hoppscotch-common/src/components/http/CodegenModal.vue b/packages/hoppscotch-common/src/components/http/CodegenModal.vue
index d3186aabc..f04c4aa94 100644
--- a/packages/hoppscotch-common/src/components/http/CodegenModal.vue
+++ b/packages/hoppscotch-common/src/components/http/CodegenModal.vue
@@ -148,7 +148,6 @@ import {
resolvesEnvsInBody,
} from "~/helpers/utils/EffectiveURL"
import { getAggregateEnvs } from "~/newstore/environments"
-import { getRESTRequest } from "~/newstore/RESTSession"
import { useI18n } from "@composables/i18n"
import { useToast } from "@composables/toast"
import {
@@ -164,6 +163,8 @@ import {
import IconCopy from "~icons/lucide/copy"
import IconCheck from "~icons/lucide/check"
import IconWrapText from "~icons/lucide/wrap-text"
+import { currentActiveTab } from "~/helpers/rest/tab"
+import cloneDeep from "lodash-es/cloneDeep"
const t = useI18n()
@@ -177,7 +178,7 @@ const emit = defineEmits<{
const toast = useToast()
-const request = ref(getRESTRequest())
+const request = ref(cloneDeep(currentActiveTab.value.document.request))
const codegenType = ref<CodegenName>("shell-curl")
const errorState = ref(false)
@@ -246,7 +247,7 @@ watch(
() => props.show,
(goingToShow) => {
if (goingToShow) {
- request.value = getRESTRequest()
+ request.value = cloneDeep(currentActiveTab.value.document.request)
}
}
)
diff --git a/packages/hoppscotch-common/src/components/http/Headers.vue b/packages/hoppscotch-common/src/components/http/Headers.vue
index 33a7dd502..aabac36b9 100644
--- a/packages/hoppscotch-common/src/components/http/Headers.vue
+++ b/packages/hoppscotch-common/src/components/http/Headers.vue
@@ -48,7 +48,7 @@
<div v-else>
<draggable
v-model="workingHeaders"
- :item-key="(header) => `header-${header.id}`"
+ :item-key="(header: WorkingHeader) => `header-${header.id}`"
animation="250"
handle=".draggable-handle"
draggable=".draggable-content"
@@ -240,10 +240,11 @@ import IconEyeOff from "~icons/lucide/eye-off"
import IconArrowUpRight from "~icons/lucide/arrow-up-right"
import IconWrapText from "~icons/lucide/wrap-text"
import { useColorMode } from "@composables/theming"
-import { computed, reactive, Ref, ref, watch } from "vue"
+import { computed, reactive, ref, watch } from "vue"
import { isEqual, cloneDeep } from "lodash-es"
import {
HoppRESTHeader,
+ HoppRESTRequest,
parseRawKeyValueEntriesE,
rawKeyValueEntriesToString,
RawKeyValueEntry,
@@ -256,15 +257,9 @@ import * as A from "fp-ts/Array"
import draggable from "vuedraggable-es"
import { RequestOptionTabs } from "./RequestOptions.vue"
import { useCodemirror } from "@composables/codemirror"
-import {
- getRESTRequest,
- restHeaders$,
- restRequest$,
- setRESTHeaders,
-} from "~/newstore/RESTSession"
import { commonHeaders } from "~/helpers/headers"
import { useI18n } from "@composables/i18n"
-import { useReadonlyStream, useStream } from "@composables/stream"
+import { useReadonlyStream } from "@composables/stream"
import { useToast } from "@composables/toast"
import linter from "~/helpers/editor/linting/rawKeyValue"
import { throwError } from "~/helpers/functional/error"
@@ -274,6 +269,7 @@ import {
getComputedHeaders,
} from "~/helpers/utils/EffectiveURL"
import { aggregateEnvs$, getAggregateEnvs } from "~/newstore/environments"
+import { useVModel } from "@vueuse/core"
const t = useI18n()
const toast = useToast()
@@ -288,10 +284,16 @@ const linewrapEnabled = ref(true)
const deletionToast = ref<{ goAway: (delay: number) => void } | null>(null)
+// v-model integration with props and emit
+const props = defineProps<{ modelValue: HoppRESTRequest }>()
+
const emit = defineEmits<{
(e: "change-tab", value: RequestOptionTabs): void
+ (e: "update:modelValue", value: HoppRESTRequest): void
}>()
+const request = useVModel(props, "modelValue", emit)
+
useCodemirror(
bulkEditor,
bulkHeaders,
@@ -307,13 +309,10 @@ useCodemirror(
})
)
-// The functional headers list (the headers actually in the system)
-const headers = useStream(restHeaders$, [], setRESTHeaders) as Ref<
- HoppRESTHeader[]
->
+type WorkingHeader = HoppRESTHeader & { id: number }
// The UI representation of the headers list (has the empty end headers)
-const workingHeaders = ref<Array<HoppRESTHeader & { id: number }>>([
+const workingHeaders = ref<Array<WorkingHeader>>([
{
id: idTicker.value++,
key: "",
@@ -339,7 +338,7 @@ watch(workingHeaders, (headersList) => {
// Sync logic between headers and working/bulk headers
watch(
- headers,
+ request.value.headers,
(newHeadersList) => {
// Sync should overwrite working headers
const filteredWorkingHeaders = pipe(
@@ -388,8 +387,8 @@ watch(workingHeaders, (newWorkingHeaders) => {
)
)
- if (!isEqual(headers.value, fixedHeaders)) {
- headers.value = cloneDeep(fixedHeaders)
+ if (!isEqual(request.value.headers, fixedHeaders)) {
+ request.value.headers = cloneDeep(fixedHeaders)
}
})
@@ -405,8 +404,8 @@ watch(bulkHeaders, (newBulkHeaders) => {
E.getOrElse(() => [] as RawKeyValueEntry[])
)
- if (!isEqual(headers.value, filteredBulkHeaders)) {
- headers.value = filteredBulkHeaders
+ if (!isEqual(props.modelValue, filteredBulkHeaders)) {
+ request.value.headers = filteredBulkHeaders
}
})
@@ -481,11 +480,10 @@ const clearContent = () => {
bulkHeaders.value = ""
}
-const restRequest = useReadonlyStream(restRequest$, getRESTRequest())
const aggregateEnvs = useReadonlyStream(aggregateEnvs$, getAggregateEnvs())
const computedHeaders = computed(() =>
- getComputedHeaders(restRequest.value, aggregateEnvs.value).map(
+ getComputedHeaders(request.value, aggregateEnvs.value).map(
(header, index) => ({
id: `header-${index}`,
...header,
diff --git a/packages/hoppscotch-common/src/components/http/ImportCurl.vue b/packages/hoppscotch-common/src/components/http/ImportCurl.vue
index 5912570d1..7c6293a25 100644
--- a/packages/hoppscotch-common/src/components/http/ImportCurl.vue
+++ b/packages/hoppscotch-common/src/components/http/ImportCurl.vue
@@ -81,7 +81,6 @@
import { reactive, ref, watch } from "vue"
import { refAutoReset } from "@vueuse/core"
import { useCodemirror } from "@composables/codemirror"
-import { setRESTRequest } from "~/newstore/RESTSession"
import { useI18n } from "@composables/i18n"
import { useToast } from "@composables/toast"
import { parseCurlToHoppRESTReq } from "~/helpers/curl"
@@ -94,6 +93,7 @@ import IconWrapText from "~icons/lucide/wrap-text"
import IconClipboard from "~icons/lucide/clipboard"
import IconCheck from "~icons/lucide/check"
import IconTrash2 from "~icons/lucide/trash-2"
+import { currentActiveTab } from "~/helpers/rest/tab"
const t = useI18n()
@@ -144,7 +144,7 @@ const handleImport = () => {
try {
const req = parseCurlToHoppRESTReq(text)
- setRESTRequest(req)
+ currentActiveTab.value.document.request = req
} catch (e) {
console.error(e)
toast.error(`${t("error.curl_invalid_format")}`)
diff --git a/packages/hoppscotch-common/src/components/http/OAuth2Authorization.vue b/packages/hoppscotch-common/src/components/http/OAuth2Authorization.vue
index f6798684b..273314bfa 100644
--- a/packages/hoppscotch-common/src/components/http/OAuth2Authorization.vue
+++ b/packages/hoppscotch-common/src/components/http/OAuth2Authorization.vue
@@ -31,89 +31,72 @@
</div>
</template>
-<script lang="ts">
-import { Ref, defineComponent } from "vue"
+<script setup lang="ts">
+import { ref, watch } from "vue"
import { HoppRESTAuthOAuth2, parseTemplateString } from "@hoppscotch/data"
import { pluckRef } from "@composables/ref"
import { useI18n } from "@composables/i18n"
-import { useStream } from "@composables/stream"
import { useToast } from "@composables/toast"
-import { restAuth$, setRESTAuth } from "~/newstore/RESTSession"
import { tokenRequest } from "~/helpers/oauth"
import { getCombinedEnvVariables } from "~/helpers/preRequest"
-export default defineComponent({
- setup() {
- const t = useI18n()
- const toast = useToast()
+const t = useI18n()
+const toast = useToast()
- const auth = useStream(
- restAuth$,
- { authType: "none", authActive: true },
- setRESTAuth
- )
+const props = defineProps<{
+ modelValue: HoppRESTAuthOAuth2
+}>()
- const oidcDiscoveryURL = pluckRef(
- auth as Ref<HoppRESTAuthOAuth2>,
- "oidcDiscoveryURL"
- )
+const emit = defineEmits<{
+ (e: "update:modelValue", value: HoppRESTAuthOAuth2): void
+}>()
- const authURL = pluckRef(auth as Ref<HoppRESTAuthOAuth2>, "authURL")
+const auth = ref(props.modelValue)
- const accessTokenURL = pluckRef(
- auth as Ref<HoppRESTAuthOAuth2>,
- "accessTokenURL"
- )
+watch(
+ () => auth.value,
+ (val) => {
+ emit("update:modelValue", val)
+ }
+)
- const clientID = pluckRef(auth as Ref<HoppRESTAuthOAuth2>, "clientID")
+const oidcDiscoveryURL = pluckRef(auth, "oidcDiscoveryURL")
- const clientSecret = pluckRef(
- auth as Ref<HoppRESTAuthOAuth2>,
- "clientSecret"
- )
+const authURL = pluckRef(auth, "authURL")
- const scope = pluckRef(auth as Ref<HoppRESTAuthOAuth2>, "scope")
+const accessTokenURL = pluckRef(auth, "accessTokenURL")
- const handleAccessTokenRequest = async () => {
- if (
- oidcDiscoveryURL.value === "" &&
- (authURL.value === "" || accessTokenURL.value === "")
- ) {
- toast.error(`${t("error.incomplete_config_urls")}`)
- return
- }
- const envs = getCombinedEnvVariables()
- const envVars = [...envs.selected, ...envs.global]
+const clientID = pluckRef(auth, "clientID")
- try {
- const tokenReqParams = {
- grantType: "code",
- oidcDiscoveryUrl: parseTemplateString(
- oidcDiscoveryURL.value,
- envVars
- ),
- authUrl: parseTemplateString(authURL.value, envVars),
- accessTokenUrl: parseTemplateString(accessTokenURL.value, envVars),
- clientId: parseTemplateString(clientID.value, envVars),
- clientSecret: parseTemplateString(clientSecret.value, envVars),
- scope: parseTemplateString(scope.value, envVars),
- }
- await tokenRequest(tokenReqParams)
- } catch (e) {
- toast.error(`${e}`)
- }
- }
+// TODO: Fix this type error. currently there is no type for clientSecret
+const clientSecret = pluckRef(auth, "clientSecret" as any)
+
+const scope = pluckRef(auth, "scope")
+
+const handleAccessTokenRequest = async () => {
+ if (
+ oidcDiscoveryURL.value === "" &&
+ (authURL.value === "" || accessTokenURL.value === "")
+ ) {
+ toast.error(`${t("error.incomplete_config_urls")}`)
+ return
+ }
+ const envs = getCombinedEnvVariables()
+ const envVars = [...envs.selected, ...envs.global]
- return {
- oidcDiscoveryURL,
- authURL,
- accessTokenURL,
- clientID,
- clientSecret,
- scope,
- handleAccessTokenRequest,
- t,
+ try {
+ const tokenReqParams = {
+ grantType: "code",
+ oidcDiscoveryUrl: parseTemplateString(oidcDiscoveryURL.value, envVars),
+ authUrl: parseTemplateString(authURL.value, envVars),
+ accessTokenUrl: parseTemplateString(accessTokenURL.value, envVars),
+ clientId: parseTemplateString(clientID.value, envVars),
+ clientSecret: parseTemplateString(clientSecret.value, envVars),
+ scope: parseTemplateString(scope.value, envVars),
}
- },
-})
+ await tokenRequest(tokenReqParams)
+ } catch (e) {
+ toast.error(`${e}`)
+ }
+}
</script>
diff --git a/packages/hoppscotch-common/src/components/http/Parameters.vue b/packages/hoppscotch-common/src/components/http/Parameters.vue
index 87fccf142..030ec6888 100644
--- a/packages/hoppscotch-common/src/components/http/Parameters.vue
+++ b/packages/hoppscotch-common/src/components/http/Parameters.vue
@@ -179,7 +179,7 @@ import IconCheckCircle from "~icons/lucide/check-circle"
import IconCircle from "~icons/lucide/circle"
import IconTrash from "~icons/lucide/trash"
import IconWrapText from "~icons/lucide/wrap-text"
-import { reactive, Ref, ref, watch } from "vue"
+import { reactive, ref, watch } from "vue"
import { flow, pipe } from "fp-ts/function"
import * as O from "fp-ts/Option"
import * as A from "fp-ts/Array"
@@ -198,10 +198,9 @@ import { useCodemirror } from "@composables/codemirror"
import { useColorMode } from "@composables/theming"
import { useI18n } from "@composables/i18n"
import { useToast } from "@composables/toast"
-import { useStream } from "@composables/stream"
-import { restParams$, setRESTParams } from "~/newstore/RESTSession"
import { throwError } from "@functional/error"
import { objRemoveKey } from "@functional/object"
+import { useVModel } from "@vueuse/core"
const colorMode = useColorMode()
@@ -232,8 +231,16 @@ useCodemirror(
})
)
+const props = defineProps<{
+ modelValue: HoppRESTParam[]
+}>()
+
+const emit = defineEmits<{
+ (e: "update:modelValue", value: Array<HoppRESTParam>): void
+}>()
+
// The functional parameters list (the parameters actually applied to the session)
-const params = useStream(restParams$, [], setRESTParams) as Ref<HoppRESTParam[]>
+const params = useVModel(props, "modelValue", emit)
// The UI representation of the parameters list (has the empty end param)
const workingParams = ref<Array<HoppRESTParam & { id: number }>>([
diff --git a/packages/hoppscotch-common/src/components/http/PreRequestScript.vue b/packages/hoppscotch-common/src/components/http/PreRequestScript.vue
index 62e8f25bc..9146e3663 100644
--- a/packages/hoppscotch-common/src/components/http/PreRequestScript.vue
+++ b/packages/hoppscotch-common/src/components/http/PreRequestScript.vue
@@ -66,16 +66,23 @@ import IconHelpCircle from "~icons/lucide/help-circle"
import IconWrapText from "~icons/lucide/wrap-text"
import IconTrash2 from "~icons/lucide/trash-2"
import { reactive, ref } from "vue"
-import { usePreRequestScript } from "~/newstore/RESTSession"
import snippets from "@helpers/preRequestScriptSnippets"
import { useCodemirror } from "@composables/codemirror"
import linter from "~/helpers/editor/linting/preRequest"
import completer from "~/helpers/editor/completion/preRequest"
import { useI18n } from "@composables/i18n"
+import { useVModel } from "@vueuse/core"
const t = useI18n()
-const preRequestScript = usePreRequestScript()
+const props = defineProps<{
+ modelValue: string
+}>()
+const emit = defineEmits<{
+ (e: "update:modelValue", value: string): void
+}>()
+
+const preRequestScript = useVModel(props, "modelValue", emit)
const preRequestEditor = ref<any | null>(null)
const linewrapEnabled = ref(true)
diff --git a/packages/hoppscotch-common/src/components/http/RawBody.vue b/packages/hoppscotch-common/src/components/http/RawBody.vue
index b71f27497..0d442d920 100644
--- a/packages/hoppscotch-common/src/components/http/RawBody.vue
+++ b/packages/hoppscotch-common/src/components/http/RawBody.vue
@@ -35,7 +35,7 @@
'application/hal+json',
'application/vnd.api+json',
'application/xml',
- ].includes(contentType)
+ ].includes(body.contentType)
"
v-tippy="{ theme: 'tooltip' }"
:title="t('action.prettify')"
@@ -74,16 +74,14 @@ import IconInfo from "~icons/lucide/info"
import { computed, reactive, Ref, ref, watch } from "vue"
import * as TO from "fp-ts/TaskOption"
import { pipe } from "fp-ts/function"
-import { ValidContentTypes } from "@hoppscotch/data"
-import { refAutoReset } from "@vueuse/core"
+import { HoppRESTReqBody, ValidContentTypes } from "@hoppscotch/data"
+import { refAutoReset, useVModel } from "@vueuse/core"
import { useCodemirror } from "@composables/codemirror"
import { getEditorLangForMimeType } from "@helpers/editorutils"
import { pluckRef } from "@composables/ref"
import { useI18n } from "@composables/i18n"
import { useToast } from "@composables/toast"
import { isJSONContentType } from "~/helpers/utils/contenttypes"
-import { useRESTRequestBody } from "~/newstore/RESTSession"
-
import jsonLinter from "~/helpers/editor/linting/json"
import { readFileAsText } from "~/helpers/functional/files"
@@ -92,27 +90,35 @@ type PossibleContentTypes = Exclude<
"multipart/form-data" | "application/x-www-form-urlencoded"
>
-const t = useI18n()
-
-const payload = ref<HTMLInputElement | null>(null)
+type Body = HoppRESTReqBody & { contentType: PossibleContentTypes }
const props = defineProps<{
- contentType: PossibleContentTypes
+ modelValue: Body
+}>()
+
+const emit = defineEmits<{
+ (e: "update:modelValue", val: Body): void
}>()
+const body = useVModel(props, "modelValue", emit)
+
+const t = useI18n()
+
+const payload = ref<HTMLInputElement | null>(null)
+
const toast = useToast()
-const rawParamsBody = pluckRef(useRESTRequestBody(), "body")
+const rawParamsBody = pluckRef(body, "body")
const prettifyIcon = refAutoReset<
typeof IconWand2 | typeof IconCheck | typeof IconInfo
>(IconWand2, 1000)
const rawInputEditorLang = computed(() =>
- getEditorLangForMimeType(props.contentType)
+ getEditorLangForMimeType(body.value.contentType)
)
const langLinter = computed(() =>
- isJSONContentType(props.contentType) ? jsonLinter : null
+ isJSONContentType(body.value.contentType) ? jsonLinter : null
)
const linewrapEnabled = ref(true)
@@ -175,10 +181,10 @@ const uploadPayload = async (e: Event) => {
const prettifyRequestBody = () => {
let prettifyBody = ""
try {
- if (props.contentType.endsWith("json")) {
+ if (body.value.contentType.endsWith("json")) {
const jsonObj = JSON.parse(rawParamsBody.value as string)
prettifyBody = JSON.stringify(jsonObj, null, 2)
- } else if (props.contentType == "application/xml") {
+ } else if (body.value.contentType == "application/xml") {
prettifyBody = prettifyXML(rawParamsBody.value as string)
}
rawParamsBody.value = prettifyBody
diff --git a/packages/hoppscotch-common/src/components/http/Request.vue b/packages/hoppscotch-common/src/components/http/Request.vue
index 921f81625..ed98b98cf 100644
--- a/packages/hoppscotch-common/src/components/http/Request.vue
+++ b/packages/hoppscotch-common/src/components/http/Request.vue
@@ -17,10 +17,10 @@
<input
id="method"
class="flex px-4 py-2 font-semibold transition rounded-l cursor-pointer text-secondaryDark w-26 bg-primaryLight"
- :value="newMethod"
+ :value="tab.document.request.method"
:readonly="!isCustomMethod"
:placeholder="`${t('request.method')}`"
- @input="onSelectMethod($event.target.value)"
+ @input="onSelectMethod($event)"
/>
</span>
<template #content="{ hide }">
@@ -36,7 +36,7 @@
:label="method"
@click="
() => {
- onSelectMethod(method)
+ updateMethod(method)
hide()
}
"
@@ -50,7 +50,7 @@
class="flex flex-1 overflow-auto transition border-l rounded-r border-divider bg-primaryLight whitespace-nowrap"
>
<SmartEnvInput
- v-model="newEndpoint"
+ v-model="tab.document.request.endpoint"
:placeholder="`${t('request.url')}`"
@enter="newSendRequest()"
@paste="onPasteUrl($event)"
@@ -161,12 +161,11 @@
ref="saveTippyActions"
class="flex flex-col focus:outline-none"
tabindex="0"
- @keyup.s="saveRequestAction.$el.click()"
@keyup.escape="hide()"
>
<input
id="request-name"
- v-model="requestName"
+ v-model="tab.document.request.name"
:placeholder="`${t('request.name')}`"
name="request-name"
type="text"
@@ -195,7 +194,6 @@
ref="saveRequestAction"
:label="`${t('request.save_as')}`"
:icon="IconFolderPlus"
- :shortcut="['S']"
@click="
() => {
showSaveRequestModal = true
@@ -227,55 +225,40 @@
</template>
<script setup lang="ts">
-import IconShare2 from "~icons/lucide/share-2"
-import IconCopy from "~icons/lucide/copy"
-import IconCheck from "~icons/lucide/check"
-import IconFileCode from "~icons/lucide/file-code"
-import IconCode2 from "~icons/lucide/code-2"
-import IconRotateCCW from "~icons/lucide/rotate-ccw"
-import IconSave from "~icons/lucide/save"
-import IconChevronDown from "~icons/lucide/chevron-down"
-import IconLink2 from "~icons/lucide/link-2"
-import IconFolderPlus from "~icons/lucide/folder-plus"
-import { computed, ref, watch } from "vue"
-import { isLeft, isRight } from "fp-ts/lib/Either"
-import * as E from "fp-ts/Either"
-import { cloneDeep } from "lodash-es"
-import { refAutoReset } from "@vueuse/core"
-import {
- updateRESTResponse,
- restEndpoint$,
- setRESTEndpoint,
- restMethod$,
- updateRESTMethod,
- resetRESTRequest,
- useRESTRequestName,
- getRESTSaveContext,
- getRESTRequest,
- restRequest$,
- setRESTSaveContext,
-} from "~/newstore/RESTSession"
-import { editRESTRequest } from "~/newstore/collections"
-import { runRESTRequest$ } from "~/helpers/RequestRunner"
-import {
- useStream,
- useStreamSubscriber,
- useReadonlyStream,
-} from "@composables/stream"
import { useI18n } from "@composables/i18n"
-import { useToast } from "@composables/toast"
import { useSetting } from "@composables/settings"
-import { startPageProgress, completePageProgress } from "@modules/loadingbar"
+import { useStreamSubscriber } from "@composables/stream"
+import { useToast } from "@composables/toast"
+import { completePageProgress, startPageProgress } from "@modules/loadingbar"
+import { refAutoReset, useVModel } from "@vueuse/core"
+import * as E from "fp-ts/Either"
+import { isLeft, isRight } from "fp-ts/lib/Either"
+import { computed, ref, watch } from "vue"
import { defineActionHandler } from "~/helpers/actions"
-import { copyToClipboard } from "~/helpers/utils/clipboard"
-import { createShortcode } from "~/helpers/backend/mutations/Shortcode"
import { runMutation } from "~/helpers/backend/GQLClient"
import { UpdateRequestDocument } from "~/helpers/backend/graphql"
+import { createShortcode } from "~/helpers/backend/mutations/Shortcode"
import { getPlatformSpecialKey as getSpecialKey } from "~/helpers/platformutils"
import {
cancelRunningExtensionRequest,
hasExtensionInstalled,
} from "~/helpers/strategies/ExtensionStrategy"
+import { runRESTRequest$ } from "~/helpers/RequestRunner"
+import { HoppRESTResponse } from "~/helpers/types/HoppRESTResponse"
+import { copyToClipboard } from "~/helpers/utils/clipboard"
+import { editRESTRequest } from "~/newstore/collections"
+import IconCheck from "~icons/lucide/check"
+import IconChevronDown from "~icons/lucide/chevron-down"
+import IconCode2 from "~icons/lucide/code-2"
+import IconCopy from "~icons/lucide/copy"
+import IconFileCode from "~icons/lucide/file-code"
+import IconFolderPlus from "~icons/lucide/folder-plus"
+import IconLink2 from "~icons/lucide/link-2"
+import IconRotateCCW from "~icons/lucide/rotate-ccw"
+import IconSave from "~icons/lucide/save"
+import IconShare2 from "~icons/lucide/share-2"
+import { HoppRESTTab } from "~/helpers/rest/tab"
+import { getDefaultRESTRequest } from "~/helpers/rest/default"
const t = useI18n()
@@ -296,9 +279,19 @@ const toast = useToast()
const { subscribeToStream } = useStreamSubscriber()
-const newEndpoint = useStream(restEndpoint$, "", setRESTEndpoint)
+const props = defineProps<{ modelValue: HoppRESTTab }>()
+const emit = defineEmits(["update:modelValue"])
+
+const tab = useVModel(props, "modelValue", emit)
+
+const newEndpoint = computed(() => {
+ return tab.value.document.request.endpoint
+})
+const newMethod = computed(() => {
+ return tab.value.document.request.method
+})
+
const curlText = ref("")
-const newMethod = useStream(restMethod$, "", updateRESTMethod)
const loading = ref(false)
@@ -327,6 +320,30 @@ watch(loading, () => {
}
})
+// TODO: make this oAuthURL() work
+
+// function oAuthURL() {
+// const auth = useReadonlyStream(props.request.auth$, {
+// authType: "none",
+// authActive: true,
+// })
+
+// const oauth2Token = pluckRef(auth as Ref<HoppRESTAuthOAuth2>, "token")
+
+// onBeforeMount(async () => {
+// try {
+// const tokenInfo = await oauthRedirect()
+// if (Object.prototype.hasOwnProperty.call(tokenInfo, "access_token")) {
+// if (typeof tokenInfo === "object") {
+// oauth2Token.value = tokenInfo.access_token
+// }
+// }
+
+// // eslint-disable-next-line no-empty
+// } catch (_) {}
+// })
+// }
+
const newSendRequest = async () => {
if (newEndpoint.value === "" || /^\s+$/.test(newEndpoint.value)) {
toast.error(`${t("empty.endpoint")}`)
@@ -335,10 +352,14 @@ const newSendRequest = async () => {
ensureMethodInEndpoint()
+ console.log("Sending request", newEndpoint.value)
+
loading.value = true
// Double calling is because the function returns a TaskEither than should be executed
- const streamResult = await runRESTRequest$()()
+ const streamResult = await runRESTRequest$(tab)()
+
+ console.log("Stream result", streamResult)
if (isRight(streamResult)) {
subscribeToStream(
@@ -380,9 +401,11 @@ const ensureMethodInEndpoint = () => {
) {
const domain = newEndpoint.value.split(/[/:#?]+/)[0]
if (domain === "localhost" || /([0-9]+\.)*[0-9]/.test(domain)) {
- setRESTEndpoint("http://" + newEndpoint.value)
+ tab.value.document.request.endpoint =
+ "http://" + tab.value.document.request.endpoint
} else {
- setRESTEndpoint("https://" + newEndpoint.value)
+ tab.value.document.request.endpoint =
+ "https://" + tab.value.document.request.endpoint
}
}
}
@@ -395,7 +418,7 @@ const onPasteUrl = (e: { pastedValue: string; prevValue: string }) => {
if (isCURL(pastedData)) {
showCurlImportModal.value = true
curlText.value = pastedData
- newEndpoint.value = e.prevValue
+ tab.value.document.request.endpoint = e.prevValue
}
}
@@ -412,15 +435,21 @@ const cancelRequest = () => {
}
const updateMethod = (method: string) => {
- updateRESTMethod(method)
+ tab.value.document.request.method = method
}
-const onSelectMethod = (method: string) => {
- updateMethod(method)
+const onSelectMethod = (e: Event | any) => {
+ // type any because of value property not being recognized by TS in the event.target object. It is a valid property though.
+ updateMethod(e.value)
}
const clearContent = () => {
- resetRESTRequest()
+ tab.value.document.request = getDefaultRESTRequest()
+}
+
+const updateRESTResponse = (response: HoppRESTResponse | null) => {
+ tab.value.response = response
+ console.log("Updating response", response)
}
const copyLinkIcon = refAutoReset<
@@ -440,20 +469,13 @@ const shareButtonText = computed(() => {
}
})
-const request = useReadonlyStream(restRequest$, getRESTRequest())
-
-watch(request, () => {
- shareLink.value = null
-})
-
const copyRequest = async () => {
if (shareLink.value) {
copyShareLink(shareLink.value)
} else {
shareLink.value = ""
fetchingShareLink.value = true
- const request = getRESTRequest()
- const shortcodeResult = await createShortcode(request)()
+ const shortcodeResult = await createShortcode(tab.value.document.request)()
if (E.isLeft(shortcodeResult)) {
toast.error(`${shortcodeResult.left.error}`)
shareLink.value = `${t("error.something_went_wrong")}`
@@ -511,33 +533,26 @@ const cycleDownMethod = () => {
}
const saveRequest = () => {
- const saveCtx = getRESTSaveContext()
+ const saveCtx = tab.value.document.saveContext
+
if (!saveCtx) {
showSaveRequestModal.value = true
return
}
if (saveCtx.originLocation === "user-collection") {
- const req = getRESTRequest()
+ const req = tab.value.document.request
try {
- editRESTRequest(
- saveCtx.folderPath,
- saveCtx.requestIndex,
- getRESTRequest()
- )
- setRESTSaveContext({
- originLocation: "user-collection",
- folderPath: saveCtx.folderPath,
- requestIndex: saveCtx.requestIndex,
- req: cloneDeep(req),
- })
+ editRESTRequest(saveCtx.folderPath, saveCtx.requestIndex, req)
+
+ tab.value.document.isDirty = false
toast.success(`${t("request.saved")}`)
} catch (e) {
- setRESTSaveContext(null)
+ tab.value.document.saveContext = undefined
saveRequest()
}
} else if (saveCtx.originLocation === "team-collection") {
- const req = getRESTRequest()
+ const req = tab.value.document.request
// TODO: handle error case (NOTE: overwriteRequestTeams is async)
try {
@@ -551,11 +566,8 @@ const saveRequest = () => {
if (E.isLeft(result)) {
toast.error(`${t("profile.no_permission")}`)
} else {
- setRESTSaveContext({
- originLocation: "team-collection",
- requestID: saveCtx.requestID,
- req: cloneDeep(req),
- })
+ tab.value.document.isDirty = false
+
toast.success(`${t("request.saved")}`)
}
})
@@ -587,10 +599,11 @@ defineActionHandler("request.method.delete", () => updateMethod("DELETE"))
defineActionHandler("request.method.head", () => updateMethod("HEAD"))
const isCustomMethod = computed(() => {
- return newMethod.value === "CUSTOM" || !methods.includes(newMethod.value)
+ return (
+ tab.value.document.request.method === "CUSTOM" ||
+ !methods.includes(newMethod.value)
+ )
})
-const requestName = useRESTRequestName()
-
const COLUMN_LAYOUT = useSetting("COLUMN_LAYOUT")
</script>
diff --git a/packages/hoppscotch-common/src/components/http/RequestOptions.vue b/packages/hoppscotch-common/src/components/http/RequestOptions.vue
index a8a26a829..28e238b8f 100644
--- a/packages/hoppscotch-common/src/components/http/RequestOptions.vue
+++ b/packages/hoppscotch-common/src/components/http/RequestOptions.vue
@@ -9,51 +9,52 @@
:label="`${t('tab.parameters')}`"
:info="`${newActiveParamsCount$}`"
>
- <HttpParameters />
+ <HttpParameters v-model="request.params" />
</HoppSmartTab>
<HoppSmartTab :id="'bodyParams'" :label="`${t('tab.body')}`">
- <HttpBody @change-tab="changeTab" />
+ <HttpBody
+ v-model:headers="request.headers"
+ v-model:body="request.body"
+ @change-tab="changeTab"
+ />
</HoppSmartTab>
<HoppSmartTab
:id="'headers'"
:label="`${t('tab.headers')}`"
:info="`${newActiveHeadersCount$}`"
>
- <HttpHeaders @change-tab="changeTab" />
+ <HttpHeaders v-model="request" @change-tab="changeTab" />
</HoppSmartTab>
<HoppSmartTab :id="'authorization'" :label="`${t('tab.authorization')}`">
- <HttpAuthorization />
+ <HttpAuthorization v-model="request.auth" />
</HoppSmartTab>
<HoppSmartTab
:id="'preRequestScript'"
:label="`${t('tab.pre_request_script')}`"
:indicator="
- preRequestScript && preRequestScript.length > 0 ? true : false
+ request.preRequestScript && request.preRequestScript.length > 0
+ ? true
+ : false
"
>
- <HttpPreRequestScript />
+ <HttpPreRequestScript v-model="request.preRequestScript" />
</HoppSmartTab>
<HoppSmartTab
:id="'tests'"
:label="`${t('tab.tests')}`"
- :indicator="testScript && testScript.length > 0 ? true : false"
+ :indicator="
+ request.testScript && request.testScript.length > 0 ? true : false
+ "
>
- <HttpTests />
+ <HttpTests v-model="request.testScript" />
</HoppSmartTab>
</HoppSmartTabs>
</template>
<script setup lang="ts">
-import { ref } from "vue"
-import { map } from "rxjs/operators"
-import { useReadonlyStream } from "@composables/stream"
-import {
- restActiveHeadersCount$,
- restActiveParamsCount$,
- usePreRequestScript,
- useTestScript,
-} from "~/newstore/RESTSession"
import { useI18n } from "@composables/i18n"
+import { HoppRESTRequest } from "@hoppscotch/data"
+import { computed, ref, watch } from "vue"
export type RequestOptionTabs =
| "params"
@@ -63,33 +64,43 @@ export type RequestOptionTabs =
const t = useI18n()
+// v-model integration with props and emit
+const props = defineProps<{ modelValue: HoppRESTRequest }>()
+const emit = defineEmits<{
+ (e: "update:modelValue", value: HoppRESTRequest): void
+}>()
+
+const request = ref(props.modelValue)
+
+watch(
+ () => request.value,
+ (newVal) => {
+ emit("update:modelValue", newVal)
+ },
+ { deep: true }
+)
+
const selectedRealtimeTab = ref<RequestOptionTabs>("params")
const changeTab = (e: RequestOptionTabs) => {
selectedRealtimeTab.value = e
}
-const newActiveParamsCount$ = useReadonlyStream(
- restActiveParamsCount$.pipe(
- map((e) => {
- if (e === 0) return null
- return `${e}`
- })
- ),
- null
-)
+const newActiveParamsCount$ = computed(() => {
+ const e = request.value.params.filter(
+ (x) => x.active && (x.key !== "" || x.value !== "")
+ ).length
-const newActiveHeadersCount$ = useReadonlyStream(
- restActiveHeadersCount$.pipe(
- map((e) => {
- if (e === 0) return null
- return `${e}`
- })
- ),
- null
-)
+ if (e === 0) return null
+ return `${e}`
+})
-const preRequestScript = usePreRequestScript()
+const newActiveHeadersCount$ = computed(() => {
+ const e = request.value.headers.filter(
+ (x) => x.active && (x.key !== "" || x.value !== "")
+ ).length
-const testScript = useTestScript()
+ if (e === 0) return null
+ return `${e}`
+})
</script>
diff --git a/packages/hoppscotch-common/src/components/http/RequestTab.vue b/packages/hoppscotch-common/src/components/http/RequestTab.vue
new file mode 100644
index 000000000..65fb68fd1
--- /dev/null
+++ b/packages/hoppscotch-common/src/components/http/RequestTab.vue
@@ -0,0 +1,46 @@
+<template>
+ <AppPaneLayout layout-id="rest-primary">
+ <template #primary>
+ <HttpRequest v-model="tab" />
+ <HttpRequestOptions v-model="tab.document.request" />
+ </template>
+ <template #secondary>
+ <HttpResponse v-model:tab="tab" />
+ </template>
+ </AppPaneLayout>
+</template>
+
+<script setup lang="ts">
+import { watch } from "vue"
+import { useVModel } from "@vueuse/core"
+import { HoppRESTTab } from "~/helpers/rest/tab"
+import { cloneDeep } from "lodash-es"
+import { isEqualHoppRESTRequest } from "@hoppscotch/data"
+
+// TODO: Move Response and Request execution code to over here
+
+const props = defineProps<{ modelValue: HoppRESTTab }>()
+
+const emit = defineEmits<{
+ (e: "update:modelValue", val: HoppRESTTab): void
+}>()
+
+const tab = useVModel(props, "modelValue", emit)
+
+// TODO: Come up with a better dirty check
+let oldRequest = cloneDeep(tab.value.document.request)
+watch(
+ () => tab.value.document.request,
+ (updatedValue) => {
+ if (
+ !tab.value.document.isDirty &&
+ !isEqualHoppRESTRequest(oldRequest, updatedValue)
+ ) {
+ tab.value.document.isDirty = true
+ }
+
+ oldRequest = cloneDeep(updatedValue)
+ },
+ { deep: true }
+)
+</script>
diff --git a/packages/hoppscotch-common/src/components/http/Response.vue b/packages/hoppscotch-common/src/components/http/Response.vue
index 2f6c75152..69e47cefd 100644
--- a/packages/hoppscotch-common/src/components/http/Response.vue
+++ b/packages/hoppscotch-common/src/components/http/Response.vue
@@ -1,34 +1,42 @@
<template>
<div class="flex flex-col flex-1">
- <HttpResponseMeta :response="response" />
+ <HttpResponseMeta :response="tab.response" />
<LensesResponseBodyRenderer
v-if="!loading && hasResponse"
v-model:selected-tab-preference="selectedTabPreference"
- :response="response"
+ v-model:tab="tab"
/>
</div>
</template>
<script setup lang="ts">
-import { ref, computed, watch } from "vue"
+import { computed, ref, watch } from "vue"
import { startPageProgress, completePageProgress } from "@modules/loadingbar"
-import { useReadonlyStream } from "@composables/stream"
-import { restResponse$ } from "~/newstore/RESTSession"
+import { HoppRESTTab } from "~/helpers/rest/tab"
+import { useVModel } from "@vueuse/core"
-const selectedTabPreference = ref<string | null>(null)
+const props = defineProps<{
+ tab: HoppRESTTab
+}>()
+
+const emit = defineEmits<{
+ (e: "update:tab", val: HoppRESTTab): void
+}>()
-const response = useReadonlyStream(restResponse$, null)
+const tab = useVModel(props, "tab", emit)
+
+const selectedTabPreference = ref<string | null>(null)
const hasResponse = computed(
- () => response.value?.type === "success" || response.value?.type === "fail"
+ () =>
+ tab.value.response?.type === "success" ||
+ tab.value.response?.type === "fail"
)
-const loading = computed(
- () => response.value === null || response.value.type === "loading"
-)
+const loading = computed(() => tab.value.response?.type === "loading")
-watch(response, () => {
- if (response.value?.type === "loading") startPageProgress()
+watch(loading, (isLoading) => {
+ if (isLoading) startPageProgress()
else completePageProgress()
})
</script>
diff --git a/packages/hoppscotch-common/src/components/http/ResponseMeta.vue b/packages/hoppscotch-common/src/components/http/ResponseMeta.vue
index 493f7ce50..91f122415 100644
--- a/packages/hoppscotch-common/src/components/http/ResponseMeta.vue
+++ b/packages/hoppscotch-common/src/components/http/ResponseMeta.vue
@@ -107,7 +107,7 @@ const t = useI18n()
const colorMode = useColorMode()
const props = defineProps<{
- response: HoppRESTResponse | null
+ response: HoppRESTResponse | null | undefined
}>()
/**
@@ -119,6 +119,7 @@ const props = defineProps<{
const readableResponseSize = computed(() => {
if (
props.response === null ||
+ props.response === undefined ||
props.response.type === "loading" ||
props.response.type === "network_fail" ||
props.response.type === "script_fail" ||
@@ -137,6 +138,7 @@ const readableResponseSize = computed(() => {
const statusCategory = computed(() => {
if (
props.response === null ||
+ props.response === undefined ||
props.response.type === "loading" ||
props.response.type === "network_fail" ||
props.response.type === "script_fail" ||
diff --git a/packages/hoppscotch-common/src/components/http/Sidebar.vue b/packages/hoppscotch-common/src/components/http/Sidebar.vue
index c4465ec3d..d0ecb4bbe 100644
--- a/packages/hoppscotch-common/src/components/http/Sidebar.vue
+++ b/packages/hoppscotch-common/src/components/http/Sidebar.vue
@@ -5,13 +5,6 @@
vertical
render-inactive-tabs
>
- <HoppSmartTab
- :id="'history'"
- :icon="IconClock"
- :label="`${t('tab.history')}`"
- >
- <History :page="'rest'" />
- </HoppSmartTab>
<HoppSmartTab
:id="'collections'"
:icon="IconFolder"
@@ -26,6 +19,13 @@
>
<Environments />
</HoppSmartTab>
+ <HoppSmartTab
+ :id="'history'"
+ :icon="IconClock"
+ :label="`${t('tab.history')}`"
+ >
+ <History :page="'rest'" />
+ </HoppSmartTab>
</HoppSmartTabs>
</template>
@@ -40,5 +40,5 @@ const t = useI18n()
type RequestOptionTabs = "history" | "collections" | "env"
-const selectedNavigationTab = ref<RequestOptionTabs>("history")
+const selectedNavigationTab = ref<RequestOptionTabs>("collections")
</script>
diff --git a/packages/hoppscotch-common/src/components/http/TestResult.vue b/packages/hoppscotch-common/src/components/http/TestResult.vue
index f8f9b3941..fb4cd7eb1 100644
--- a/packages/hoppscotch-common/src/components/http/TestResult.vue
+++ b/packages/hoppscotch-common/src/components/http/TestResult.vue
@@ -216,7 +216,6 @@ import {
setGlobalEnvVariables,
setSelectedEnvironmentIndex,
} from "~/newstore/environments"
-import { restTestResults$, setRESTTestResults } from "~/newstore/RESTSession"
import { HoppTestResult } from "~/helpers/types/HoppTestResult"
import IconTrash2 from "~icons/lucide/trash-2"
@@ -226,6 +225,17 @@ import IconCheck from "~icons/lucide/check"
import IconClose from "~icons/lucide/x"
import { useColorMode } from "~/composables/theming"
+import { useVModel } from "@vueuse/core"
+
+const props = defineProps<{
+ modelValue: HoppTestResult | null | undefined
+}>()
+
+const emit = defineEmits<{
+ (e: "update:modelValue", val: HoppTestResult | null | undefined): void
+}>()
+
+const testResults = useVModel(props, "modelValue", emit)
const t = useI18n()
const colorMode = useColorMode()
@@ -236,11 +246,6 @@ const displayModalAdd = (shouldDisplay: boolean) => {
showModalDetails.value = shouldDisplay
}
-const testResults = useReadonlyStream(
- restTestResults$,
- null
-) as Ref<HoppTestResult | null>
-
/**
* Get the "addition" environment variables
* @returns Array of objects with key-value pairs of arguments
@@ -250,7 +255,9 @@ const getAdditionVars = () =>
? testResults.value.envDiff.selected.additions
: []
-const clearContent = () => setRESTTestResults(null)
+const clearContent = () => {
+ testResults.value = null
+}
const haveEnvVariables = computed(() => {
if (!testResults.value) return false
diff --git a/packages/hoppscotch-common/src/components/http/Tests.vue b/packages/hoppscotch-common/src/components/http/Tests.vue
index b56245b64..15a5b738d 100644
--- a/packages/hoppscotch-common/src/components/http/Tests.vue
+++ b/packages/hoppscotch-common/src/components/http/Tests.vue
@@ -66,17 +66,20 @@ import IconHelpCircle from "~icons/lucide/help-circle"
import IconWrapText from "~icons/lucide/wrap-text"
import IconTrash2 from "~icons/lucide/trash-2"
import { reactive, ref } from "vue"
-import { useTestScript } from "~/newstore/RESTSession"
import testSnippets from "~/helpers/testSnippets"
import { useCodemirror } from "@composables/codemirror"
import linter from "~/helpers/editor/linting/testScript"
import completer from "~/helpers/editor/completion/testScript"
import { useI18n } from "@composables/i18n"
+import { useVModel } from "@vueuse/core"
const t = useI18n()
-const testScript = useTestScript()
-
+const props = defineProps<{
+ modelValue: string
+}>()
+const emit = defineEmits(["update:modelValue"])
+const testScript = useVModel(props, "modelValue", emit)
const testScriptEditor = ref<any | null>(null)
const linewrapEnabled = ref(true)
diff --git a/packages/hoppscotch-common/src/components/http/URLEncodedParams.vue b/packages/hoppscotch-common/src/components/http/URLEncodedParams.vue
index 8957eb9c4..7ba5cdc77 100644
--- a/packages/hoppscotch-common/src/components/http/URLEncodedParams.vue
+++ b/packages/hoppscotch-common/src/components/http/URLEncodedParams.vue
@@ -181,6 +181,7 @@ import IconWrapText from "~icons/lucide/wrap-text"
import { computed, reactive, ref, watch } from "vue"
import { isEqual, cloneDeep } from "lodash-es"
import {
+ HoppRESTReqBody,
parseRawKeyValueEntries,
parseRawKeyValueEntriesE,
rawKeyValueEntriesToString,
@@ -194,13 +195,27 @@ import * as E from "fp-ts/Either"
import draggable from "vuedraggable-es"
import { useCodemirror } from "@composables/codemirror"
import linter from "~/helpers/editor/linting/rawKeyValue"
-import { useRESTRequestBody } from "~/newstore/RESTSession"
import { pluckRef } from "@composables/ref"
import { useI18n } from "@composables/i18n"
import { useToast } from "@composables/toast"
import { useColorMode } from "@composables/theming"
import { objRemoveKey } from "~/helpers/functional/object"
import { throwError } from "~/helpers/functional/error"
+import { useVModel } from "@vueuse/core"
+
+type Body = HoppRESTReqBody & {
+ contentType: "application/x-www-form-urlencoded"
+}
+
+const props = defineProps<{
+ modelValue: Body
+}>()
+
+const emit = defineEmits<{
+ (e: "update:modelValue", val: Body): void
+}>()
+
+const body = useVModel(props, "modelValue", emit)
const t = useI18n()
const toast = useToast()
@@ -231,7 +246,7 @@ useCodemirror(
)
// The functional urlEncodedParams list (the urlEncodedParams actually in the system)
-const urlEncodedParamsRaw = pluckRef(useRESTRequestBody(), "body")
+const urlEncodedParamsRaw = pluckRef(body, "body")
const urlEncodedParams = computed<RawKeyValueEntry[]>({
get() {
diff --git a/packages/hoppscotch-common/src/components/http/authorization/ApiKey.vue b/packages/hoppscotch-common/src/components/http/authorization/ApiKey.vue
new file mode 100644
index 000000000..d5aa48225
--- /dev/null
+++ b/packages/hoppscotch-common/src/components/http/authorization/ApiKey.vue
@@ -0,0 +1,82 @@
+<template>
+ <div class="flex flex-1 border-b border-dividerLight">
+ <SmartEnvInput v-model="auth.key" placeholder="Key" />
+ </div>
+ <div class="flex flex-1 border-b border-dividerLight">
+ <SmartEnvInput v-model="auth.value" placeholder="Value" />
+ </div>
+ <div class="flex items-center border-b border-dividerLight">
+ <span class="flex items-center">
+ <label class="ml-4 text-secondaryLight">
+ {{ t("authorization.pass_key_by") }}
+ </label>
+ <tippy
+ interactive
+ trigger="click"
+ theme="popover"
+ :on-shown="() => authTippyActions.focus()"
+ >
+ <span class="select-wrapper">
+ <HoppButtonSecondary
+ :label="auth.addTo || t('state.none')"
+ class="pr-8 ml-2 rounded-none"
+ />
+ </span>
+ <template #content="{ hide }">
+ <div
+ ref="authTippyActions"
+ class="flex flex-col focus:outline-none"
+ tabindex="0"
+ @keyup.escape="hide()"
+ >
+ <HoppSmartItem
+ :icon="auth.addTo === 'Headers' ? IconCircleDot : IconCircle"
+ :active="auth.addTo === 'Headers'"
+ :label="'Headers'"
+ @click="
+ () => {
+ auth.addTo = 'Headers'
+ hide()
+ }
+ "
+ />
+ <HoppSmartItem
+ :icon="auth.addTo === 'Query params' ? IconCircleDot : IconCircle"
+ :active="auth.addTo === 'Query params'"
+ :label="'Query params'"
+ @click="
+ () => {
+ auth.addTo = 'Query params'
+ hide()
+ }
+ "
+ />
+ </div>
+ </template>
+ </tippy>
+ </span>
+ </div>
+</template>
+
+<script setup lang="ts">
+import IconCircle from "~icons/lucide/circle"
+import IconCircleDot from "~icons/lucide/circle-dot"
+import { useI18n } from "@composables/i18n"
+import { HoppRESTAuthAPIKey } from "@hoppscotch/data"
+import { useVModel } from "@vueuse/core"
+import { ref } from "vue"
+
+const t = useI18n()
+
+const props = defineProps<{
+ modelValue: HoppRESTAuthAPIKey
+}>()
+
+const emit = defineEmits<{
+ (e: "update:modelValue", value: HoppRESTAuthAPIKey): void
+}>()
+
+const auth = useVModel(props, "modelValue", emit)
+
+const authTippyActions = ref<any | null>(null)
+</script>
diff --git a/packages/hoppscotch-common/src/components/http/authorization/Basic.vue b/packages/hoppscotch-common/src/components/http/authorization/Basic.vue
new file mode 100644
index 000000000..b3db29a6b
--- /dev/null
+++ b/packages/hoppscotch-common/src/components/http/authorization/Basic.vue
@@ -0,0 +1,32 @@
+<template>
+ <div class="flex flex-1 border-b border-dividerLight">
+ <SmartEnvInput
+ v-model="auth.username"
+ :placeholder="t('authorization.username')"
+ />
+ </div>
+ <div class="flex flex-1 border-b border-dividerLight">
+ <SmartEnvInput
+ v-model="auth.password"
+ :placeholder="t('authorization.password')"
+ />
+ </div>
+</template>
+
+<script setup lang="ts">
+import { useI18n } from "@composables/i18n"
+import { HoppRESTAuthBasic } from "@hoppscotch/data"
+import { useVModel } from "@vueuse/core"
+
+const t = useI18n()
+
+const props = defineProps<{
+ modelValue: HoppRESTAuthBasic
+}>()
+
+const emit = defineEmits<{
+ (e: "update:modelValue", value: HoppRESTAuthBasic): void
+}>()
+
+const auth = useVModel(props, "modelValue", emit)
+</script>
diff --git a/packages/hoppscotch-common/src/components/lenses/ResponseBodyRenderer.vue b/packages/hoppscotch-common/src/components/lenses/ResponseBodyRenderer.vue
index 31a0400a2..6ad7ef987 100644
--- a/packages/hoppscotch-common/src/components/lenses/ResponseBodyRenderer.vue
+++ b/packages/hoppscotch-common/src/components/lenses/ResponseBodyRenderer.vue
@@ -1,6 +1,6 @@
<template>
<HoppSmartTabs
- v-if="response"
+ v-if="tab.response"
v-model="selectedLensTab"
styles="sticky overflow-x-auto flex-shrink-0 z-10 bg-primary top-lowerPrimaryStickyFold"
>
@@ -11,7 +11,10 @@
:label="t(lens.lensName)"
class="flex flex-col flex-1 w-full h-full"
>
- <component :is="lensRendererFor(lens.renderer)" :response="response" />
+ <component
+ :is="lensRendererFor(lens.renderer)"
+ :response="tab.response"
+ />
</HoppSmartTab>
<HoppSmartTab
v-if="maybeHeaders"
@@ -26,18 +29,18 @@
id="results"
:label="t('test.results')"
:indicator="
- testResults &&
- (testResults.expectResults.length ||
- testResults.tests.length ||
- testResults.envDiff.selected.additions.length ||
- testResults.envDiff.selected.updations.length ||
- testResults.envDiff.global.updations.length)
+ tab.testResults &&
+ (tab.testResults.expectResults.length ||
+ tab.testResults.tests.length ||
+ tab.testResults.envDiff.selected.additions.length ||
+ tab.testResults.envDiff.selected.updations.length ||
+ tab.testResults.envDiff.global.updations.length)
? true
: false
"
class="flex flex-col flex-1"
>
- <HttpTestResult />
+ <HttpTestResult v-model="tab.testResults" />
</HoppSmartTab>
</HoppSmartTabs>
</template>
@@ -49,44 +52,48 @@ import {
getLensRenderers,
Lens,
} from "~/helpers/lenses/lenses"
-import { useReadonlyStream } from "@composables/stream"
import { useI18n } from "@composables/i18n"
-import type { HoppRESTResponse } from "~/helpers/types/HoppRESTResponse"
-import { restTestResults$ } from "~/newstore/RESTSession"
+import { useVModel } from "@vueuse/core"
+import { HoppRESTTab } from "~/helpers/rest/tab"
const props = defineProps<{
- response: HoppRESTResponse | null
+ tab: HoppRESTTab
selectedTabPreference: string | null
}>()
const emit = defineEmits<{
+ (e: "update:tab", val: HoppRESTTab): void
(e: "update:selectedTabPreference", newTab: string): void
}>()
+const tab = useVModel(props, "tab", emit)
+const selectedTabPreference = useVModel(props, "selectedTabPreference", emit)
+
const allLensRenderers = getLensRenderers()
function lensRendererFor(name: string) {
return allLensRenderers[name]
}
-const testResults = useReadonlyStream(restTestResults$, null)
-
const t = useI18n()
const selectedLensTab = ref("")
const maybeHeaders = computed(() => {
if (
- !props.response ||
- !(props.response.type === "success" || props.response.type === "fail")
+ !tab.value.response ||
+ !(
+ tab.value.response.type === "success" ||
+ tab.value.response.type === "fail"
+ )
)
return null
- return props.response.headers
+ return tab.value.response.headers
})
const validLenses = computed(() => {
- if (!props.response) return []
- return getSuitableLenses(props.response)
+ if (!tab.value.response) return []
+ return getSuitableLenses(tab.value.response)
})
watch(
@@ -101,10 +108,10 @@ watch(
]
if (
- props.selectedTabPreference &&
- validRenderers.includes(props.selectedTabPreference)
+ selectedTabPreference.value &&
+ validRenderers.includes(selectedTabPreference.value)
) {
- selectedLensTab.value = props.selectedTabPreference
+ selectedLensTab.value = selectedTabPreference.value
} else {
selectedLensTab.value = newLenses[0].renderer
}
@@ -113,6 +120,6 @@ watch(
)
watch(selectedLensTab, (newLensID) => {
- emit("update:selectedTabPreference", newLensID)
+ selectedTabPreference.value = newLensID
})
</script>
diff --git a/packages/hoppscotch-common/src/components/workspace/Selector.vue b/packages/hoppscotch-common/src/components/workspace/Selector.vue
index 2724e2347..733d4d49d 100644
--- a/packages/hoppscotch-common/src/components/workspace/Selector.vue
+++ b/packages/hoppscotch-common/src/components/workspace/Selector.vue
@@ -19,6 +19,12 @@
v-if="!loading && myTeams.length === 0"
class="flex flex-col items-center justify-center flex-1 p-4 text-secondaryLight"
>
+ <img
+ :src="`/images/states/${colorMode.value}/add_group.svg`"
+ loading="lazy"
+ class="inline-flex flex-col object-contain object-center w-16 h-16 mb-8"
+ :alt="`${t('empty.teams')}`"
+ />
<span class="mb-4 text-center">
{{ t("empty.teams") }}
</span>
@@ -78,12 +84,14 @@ import { useI18n } from "@composables/i18n"
import IconUser from "~icons/lucide/user"
import IconUsers from "~icons/lucide/users"
import IconPlus from "~icons/lucide/plus"
+import { useColorMode } from "@composables/theming"
import { changeWorkspace, workspaceStatus$ } from "~/newstore/workspace"
import { GetMyTeamsQuery } from "~/helpers/backend/graphql"
import IconDone from "~icons/lucide/check"
import { useLocalState } from "~/newstore/localstate"
const t = useI18n()
+const colorMode = useColorMode()
const showModalAdd = ref(false)
diff --git a/packages/hoppscotch-common/src/helpers/RESTExtURLParams.ts b/packages/hoppscotch-common/src/helpers/RESTExtURLParams.ts
index 1b9bf5c2b..fbb81e5ac 100644
--- a/packages/hoppscotch-common/src/helpers/RESTExtURLParams.ts
+++ b/packages/hoppscotch-common/src/helpers/RESTExtURLParams.ts
@@ -1,6 +1,6 @@
import { FormDataKeyValue, HoppRESTRequest } from "@hoppscotch/data"
+import { getDefaultRESTRequest } from "./rest/default"
import { isJSONContentType } from "./utils/contenttypes"
-import { getDefaultRESTRequest } from "~/newstore/RESTSession"
/**
* Handles translations for all the hopp.io REST Shareable URL params
diff --git a/packages/hoppscotch-common/src/helpers/RESTRequest.ts b/packages/hoppscotch-common/src/helpers/RESTRequest.ts
new file mode 100644
index 000000000..d44a2d55d
--- /dev/null
+++ b/packages/hoppscotch-common/src/helpers/RESTRequest.ts
@@ -0,0 +1,293 @@
+import {
+ FormDataKeyValue,
+ HoppRESTAuth,
+ HoppRESTHeader,
+ HoppRESTParam,
+ HoppRESTReqBody,
+ HoppRESTRequest,
+ RESTReqSchemaVersion,
+ ValidContentTypes,
+} from "@hoppscotch/data"
+import { BehaviorSubject, combineLatest, map } from "rxjs"
+import { applyBodyTransition } from "~/helpers/rules/BodyTransition"
+import { HoppRESTResponse } from "./types/HoppRESTResponse"
+
+export class RESTRequest {
+ public v$ = new BehaviorSubject<typeof RESTReqSchemaVersion>(
+ RESTReqSchemaVersion
+ )
+ public name$ = new BehaviorSubject("Untitled")
+ public endpoint$ = new BehaviorSubject("https://echo.hoppscotch.io/")
+ public params$ = new BehaviorSubject<HoppRESTParam[]>([])
+ public headers$ = new BehaviorSubject<HoppRESTHeader[]>([])
+ public method$ = new BehaviorSubject("GET")
+ public auth$ = new BehaviorSubject<HoppRESTAuth>({
+ authType: "none",
+ authActive: true,
+ })
+ public preRequestScript$ = new BehaviorSubject("")
+ public testScript$ = new BehaviorSubject("")
+ public body$ = new BehaviorSubject<HoppRESTReqBody>({
+ contentType: null,
+ body: null,
+ })
+
+ public response$ = new BehaviorSubject<HoppRESTResponse | null>(null)
+
+ get request$() {
+ // any of above changes construct requests
+ return combineLatest([
+ this.v$,
+ this.name$,
+ this.endpoint$,
+ this.params$,
+ this.headers$,
+ this.method$,
+ this.auth$,
+ this.preRequestScript$,
+ this.testScript$,
+ this.body$,
+ ]).pipe(
+ map(
+ ([
+ v,
+ name,
+ endpoint,
+ params,
+ headers,
+ method,
+ auth,
+ preRequestScript,
+ testScript,
+ body,
+ ]) => ({
+ v,
+ name,
+ endpoint,
+ params,
+ headers,
+ method,
+ auth,
+ preRequestScript,
+ testScript,
+ body,
+ })
+ )
+ )
+ }
+
+ get contentType$() {
+ return this.body$.pipe(map((body) => body.contentType))
+ }
+
+ get bodyContent$() {
+ return this.body$.pipe(map((body) => body.body))
+ }
+
+ get headersCount$() {
+ return this.headers$.pipe(
+ map(
+ (params) =>
+ params.filter((x) => x.active && (x.key !== "" || x.value !== ""))
+ .length
+ )
+ )
+ }
+
+ get paramsCount$() {
+ return this.params$.pipe(
+ map(
+ (params) =>
+ params.filter((x) => x.active && (x.key !== "" || x.value !== ""))
+ .length
+ )
+ )
+ }
+
+ setName(name: string) {
+ this.name$.next(name)
+ }
+
+ setEndpoint(newURL: string) {
+ this.endpoint$.next(newURL)
+ }
+
+ setMethod(newMethod: string) {
+ this.method$.next(newMethod)
+ }
+
+ setParams(entries: HoppRESTParam[]) {
+ this.params$.next(entries)
+ }
+
+ addParam(newParam: HoppRESTParam) {
+ const newParams = this.params$.value.concat(newParam)
+ this.params$.next(newParams)
+ }
+
+ updateParam(index: number, updatedParam: HoppRESTParam) {
+ const newParams = this.params$.value.map((param, i) =>
+ i === index ? updatedParam : param
+ )
+ this.params$.next(newParams)
+ }
+
+ deleteParam(index: number) {
+ const newParams = this.params$.value.filter((_, i) => i !== index)
+ this.params$.next(newParams)
+ }
+
+ deleteAllParams() {
+ this.params$.next([])
+ }
+
+ setHeaders(entries: HoppRESTHeader[]) {
+ this.headers$.next(entries)
+ }
+
+ addHeader(newHeader: HoppRESTHeader) {
+ const newHeaders = this.headers$.value.concat(newHeader)
+ this.headers$.next(newHeaders)
+ }
+
+ updateHeader(index: number, updatedHeader: HoppRESTHeader) {
+ const newHeaders = this.headers$.value.map((header, i) =>
+ i === index ? updatedHeader : header
+ )
+ this.headers$.next(newHeaders)
+ }
+
+ deleteHeader(index: number) {
+ const newHeaders = this.headers$.value.filter((_, i) => i !== index)
+ this.headers$.next(newHeaders)
+ }
+
+ deleteAllHeaders() {
+ this.headers$.next([])
+ }
+
+ setContentType(newContentType: ValidContentTypes | null) {
+ // TODO: persist body evenafter switching content typees
+ this.body$.next(applyBodyTransition(this.body$.value, newContentType))
+ }
+
+ setBody(newBody: string | FormDataKeyValue[] | null) {
+ const body = { ...this.body$.value }
+ body.body = newBody
+ this.body$.next({ ...body })
+ }
+
+ addFormDataEntry(entry: FormDataKeyValue) {
+ if (this.body$.value.contentType !== "multipart/form-data") return {}
+ const body: HoppRESTReqBody = {
+ contentType: "multipart/form-data",
+ body: [...this.body$.value.body, entry],
+ }
+ this.body$.next(body)
+ }
+
+ deleteFormDataEntry(index: number) {
+ // Only perform update if the current content-type is formdata
+ if (this.body$.value.contentType !== "multipart/form-data") return {}
+
+ const body: HoppRESTReqBody = {
+ contentType: "multipart/form-data",
+ body: [...this.body$.value.body.filter((_, i) => i !== index)],
+ }
+
+ this.body$.next(body)
+ }
+
+ updateFormDataEntry(index: number, entry: FormDataKeyValue) {
+ // Only perform update if the current content-type is formdata
+ if (this.body$.value.contentType !== "multipart/form-data") return {}
+
+ const body: HoppRESTReqBody = {
+ contentType: "multipart/form-data",
+ body: [
+ ...this.body$.value.body.map((oldEntry, i) =>
+ i === index ? entry : oldEntry
+ ),
+ ],
+ }
+ this.body$.next(body)
+ }
+
+ deleteAllFormDataEntries() {
+ // Only perform update if the current content-type is formdata
+ if (this.body$.value.contentType !== "multipart/form-data") return {}
+
+ const body: HoppRESTReqBody = {
+ contentType: "multipart/form-data",
+ body: [],
+ }
+ this.body$.next(body)
+ }
+
+ setRequestBody(newBody: HoppRESTReqBody) {
+ this.body$.next(newBody)
+ }
+
+ setAuth(newAuth: HoppRESTAuth) {
+ this.auth$.next(newAuth)
+ }
+
+ setPreRequestScript(newScript: string) {
+ this.preRequestScript$.next(newScript)
+ }
+
+ setTestScript(newScript: string) {
+ this.testScript$.next(newScript)
+ }
+
+ updateResponse(response: HoppRESTResponse | null) {
+ this.response$.next(response)
+ }
+
+ setRequest(request: HoppRESTRequest) {
+ this.v$.next(RESTReqSchemaVersion)
+ this.name$.next(request.name)
+ this.endpoint$.next(request.endpoint)
+ this.params$.next(request.params)
+ this.headers$.next(request.headers)
+ this.method$.next(request.method)
+ this.auth$.next(request.auth)
+ this.preRequestScript$.next(request.preRequestScript)
+ this.testScript$.next(request.testScript)
+ this.body$.next(request.body)
+ }
+
+ getRequest() {
+ return {
+ v: this.v$.value,
+ name: this.name$.value,
+ endpoint: this.endpoint$.value,
+ params: this.params$.value,
+ headers: this.headers$.value,
+ method: this.method$.value,
+ auth: this.auth$.value,
+ preRequestScript: this.preRequestScript$.value,
+ testScript: this.testScript$.value,
+ body: this.body$.value,
+ }
+ }
+
+ resetRequest() {
+ this.v$.next(RESTReqSchemaVersion)
+ this.name$.next("")
+ this.endpoint$.next("")
+ this.params$.next([])
+ this.headers$.next([])
+ this.method$.next("GET")
+ this.auth$.next({
+ authType: "none",
+ authActive: false,
+ })
+ this.preRequestScript$.next("")
+ this.testScript$.next("")
+ this.body$.next({
+ contentType: null,
+ body: null,
+ })
+ }
+}
diff --git a/packages/hoppscotch-common/src/helpers/RequestRunner.ts b/packages/hoppscotch-common/src/helpers/RequestRunner.ts
index 4b6144d81..1ee02cbe4 100644
--- a/packages/hoppscotch-common/src/helpers/RequestRunner.ts
+++ b/packages/hoppscotch-common/src/helpers/RequestRunner.ts
@@ -1,6 +1,6 @@
-import { Observable } from "rxjs"
+import { Observable, Subject } from "rxjs"
import { filter } from "rxjs/operators"
-import { chain, right, TaskEither } from "fp-ts/lib/TaskEither"
+import * as TE from "fp-ts/lib/TaskEither"
import { flow, pipe } from "fp-ts/function"
import * as O from "fp-ts/Option"
import * as A from "fp-ts/Array"
@@ -22,7 +22,6 @@ import { createRESTNetworkRequestStream } from "./network"
import { HoppTestData, HoppTestResult } from "./types/HoppTestResult"
import { isJSONContentType } from "./utils/contenttypes"
import { updateTeamEnvironment } from "./backend/mutations/TeamEnvironment"
-import { getRESTRequest, setRESTTestResults } from "~/newstore/RESTSession"
import {
environmentsStore,
getCurrentEnvironment,
@@ -31,6 +30,8 @@ import {
setGlobalEnvVariables,
updateEnvironment,
} from "~/newstore/environments"
+import { HoppRESTTab } from "./rest/tab"
+import { Ref } from "vue"
const getTestableBody = (
res: HoppRESTResponse & { type: "success" | "fail" }
@@ -64,20 +65,26 @@ const combineEnvVariables = (env: {
selected: Environment["variables"]
}) => [...env.selected, ...env.global]
-export const runRESTRequest$ = (): TaskEither<
- string | Error,
- Observable<HoppRESTResponse>
-> =>
+export const executedResponses$ = new Subject<
+ HoppRESTResponse & { type: "success" | "fail " }
+>()
+
+export const runRESTRequest$ = (
+ tab: Ref<HoppRESTTab>
+): TE.TaskEither<string | Error, Observable<HoppRESTResponse>> =>
pipe(
getFinalEnvsFromPreRequest(
- getRESTRequest().preRequestScript,
+ tab.value.document.request.preRequestScript,
getCombinedEnvVariables()
),
- chain((envs) => {
- const effectiveRequest = getEffectiveRESTRequest(getRESTRequest(), {
- name: "Env",
- variables: combineEnvVariables(envs),
- })
+ TE.chain((envs) => {
+ const effectiveRequest = getEffectiveRESTRequest(
+ tab.value.document.request,
+ {
+ name: "Env",
+ variables: combineEnvVariables(envs),
+ }
+ )
const stream = createRESTNetworkRequestStream(effectiveRequest)
@@ -86,6 +93,11 @@ export const runRESTRequest$ = (): TaskEither<
.pipe(filter((res) => res.type === "success" || res.type === "fail"))
.subscribe(async (res) => {
if (res.type === "success" || res.type === "fail") {
+ executedResponses$.next(
+ // @ts-expect-error Typescript can't figure out this inference for some reason
+ res
+ )
+
const runResult = await runTestScript(res.req.testScript, envs, {
status: res.statusCode,
body: getTestableBody(res),
@@ -93,7 +105,9 @@ export const runRESTRequest$ = (): TaskEither<
})()
if (isRight(runResult)) {
- setRESTTestResults(translateToSandboxTestResults(runResult.right))
+ tab.value.testResults = translateToSandboxTestResults(
+ runResult.right
+ )
setGlobalEnvVariables(runResult.right.envs.global)
@@ -128,7 +142,7 @@ export const runRESTRequest$ = (): TaskEither<
)()
}
} else {
- setRESTTestResults({
+ tab.value.testResults = {
description: "",
expectResults: [],
tests: [],
@@ -145,14 +159,14 @@ export const runRESTRequest$ = (): TaskEither<
},
},
scriptError: true,
- })
+ }
}
subscription.unsubscribe()
}
})
- return right(stream)
+ return TE.right(stream)
})
)
diff --git a/packages/hoppscotch-common/src/helpers/collection/affectedIndex.ts b/packages/hoppscotch-common/src/helpers/collection/affectedIndex.ts
new file mode 100644
index 000000000..aa354e462
--- /dev/null
+++ b/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
+}
diff --git a/packages/hoppscotch-common/src/helpers/collection/collection.ts b/packages/hoppscotch-common/src/helpers/collection/collection.ts
new file mode 100644
index 000000000..31de08e72
--- /dev/null
+++ b/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
+}
diff --git a/packages/hoppscotch-common/src/helpers/collection/request.ts b/packages/hoppscotch-common/src/helpers/collection/request.ts
new file mode 100644
index 000000000..a4889c9b4
--- /dev/null
+++ b/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
+}
diff --git a/packages/hoppscotch-common/src/helpers/curl/curlparser.ts b/packages/hoppscotch-common/src/helpers/curl/curlparser.ts
index b6985d7b9..155923eee 100644
--- a/packages/hoppscotch-common/src/helpers/curl/curlparser.ts
+++ b/packages/hoppscotch-common/src/helpers/curl/curlparser.ts
@@ -20,7 +20,7 @@ import { getMethod } from "./sub_helpers/method"
import { concatParams, getURLObject } from "./sub_helpers/url"
import { preProcessCurlCommand } from "./sub_helpers/preproc"
import { getBody, getFArgumentMultipartData } from "./sub_helpers/body"
-import { getDefaultRESTRequest } from "~/newstore/RESTSession"
+import { getDefaultRESTRequest } from "../rest/default"
import {
objHasProperty,
objHasArrayProperty,
diff --git a/packages/hoppscotch-common/src/helpers/curl/sub_helpers/auth.ts b/packages/hoppscotch-common/src/helpers/curl/sub_helpers/auth.ts
index 4b29da063..77a234221 100644
--- a/packages/hoppscotch-common/src/helpers/curl/sub_helpers/auth.ts
+++ b/packages/hoppscotch-common/src/helpers/curl/sub_helpers/auth.ts
@@ -3,7 +3,7 @@ import parser from "yargs-parser"
import * as O from "fp-ts/Option"
import * as S from "fp-ts/string"
import { pipe } from "fp-ts/function"
-import { getDefaultRESTRequest } from "~/newstore/RESTSession"
+import { getDefaultRESTRequest } from "~/helpers/rest/default"
import { objHasProperty } from "~/helpers/functional/object"
const defaultRESTReq = getDefaultRESTRequest()
diff --git a/packages/hoppscotch-common/src/helpers/curl/sub_helpers/method.ts b/packages/hoppscotch-common/src/helpers/curl/sub_helpers/method.ts
index ba0e4f274..4b43a0e77 100644
--- a/packages/hoppscotch-common/src/helpers/curl/sub_helpers/method.ts
+++ b/packages/hoppscotch-common/src/helpers/curl/sub_helpers/method.ts
@@ -2,7 +2,7 @@ import parser from "yargs-parser"
import { pipe } from "fp-ts/function"
import * as O from "fp-ts/Option"
import * as R from "fp-ts/Refinement"
-import { getDefaultRESTRequest } from "~/newstore/RESTSession"
+import { getDefaultRESTRequest } from "~/helpers/rest/default"
import {
objHasProperty,
objHasArrayProperty,
diff --git a/packages/hoppscotch-common/src/helpers/curl/sub_helpers/url.ts b/packages/hoppscotch-common/src/helpers/curl/sub_helpers/url.ts
index ef352280f..502072492 100644
--- a/packages/hoppscotch-common/src/helpers/curl/sub_helpers/url.ts
+++ b/packages/hoppscotch-common/src/helpers/curl/sub_helpers/url.ts
@@ -2,7 +2,7 @@ import parser from "yargs-parser"
import { pipe } from "fp-ts/function"
import * as O from "fp-ts/Option"
import * as A from "fp-ts/Array"
-import { getDefaultRESTRequest } from "~/newstore/RESTSession"
+import { getDefaultRESTRequest } from "~/helpers/rest/default"
import { stringArrayJoin } from "~/helpers/functional/array"
const defaultRESTReq = getDefaultRESTRequest()
diff --git a/packages/hoppscotch-common/src/helpers/fb/request.ts b/packages/hoppscotch-common/src/helpers/fb/request.ts
deleted file mode 100644
index 7522d1b38..000000000
--- a/packages/hoppscotch-common/src/helpers/fb/request.ts
+++ /dev/null
@@ -1,87 +0,0 @@
-import {
- audit,
- combineLatest,
- distinctUntilChanged,
- EMPTY,
- from,
- map,
- Subscription,
-} from "rxjs"
-import { doc, getDoc, getFirestore, setDoc } from "firebase/firestore"
-import { cloneDeep } from "lodash-es"
-import { HoppRESTRequest, translateToNewRequest } from "@hoppscotch/data"
-import { platform } from "~/platform"
-import { HoppUser } from "~/platform/auth"
-import { restRequest$ } from "~/newstore/RESTSession"
-
-/**
- * Writes a request to a user's firestore sync
- *
- * @param user The user to write to
- * @param request The request to write to the request sync
- */
-function writeCurrentRequest(user: HoppUser, request: HoppRESTRequest) {
- const req = cloneDeep(request)
-
- // Remove FormData entries because those can't be stored on Firestore
- if (req.body.contentType === "multipart/form-data") {
- req.body.body = req.body.body.map((formData) => {
- if (!formData.isFile) return formData
-
- return {
- active: formData.active,
- isFile: false,
- key: formData.key,
- value: "",
- }
- })
- }
- return setDoc(doc(getFirestore(), "users", user.uid, "requests", "rest"), req)
-}
-
-/**
- * Loads the synced request from the firestore sync
- *
- * @returns Fetched request object if exists else null
- */
-export async function loadRequestFromSync(): Promise<HoppRESTRequest | null> {
- const currentUser = platform.auth.getCurrentUser()
-
- if (!currentUser)
- throw new Error("Cannot load request from sync without login")
-
- const fbDoc = await getDoc(
- doc(getFirestore(), "users", currentUser.uid, "requests", "rest")
- )
-
- const data = fbDoc.data()
-
- if (!data) return null
- else return translateToNewRequest(data)
-}
-
-/**
- * Performs sync of the REST Request session with Firestore.
- *
- * @returns A subscription to the sync observable stream.
- * Unsubscribe to stop syncing.
- */
-export function startRequestSync(): Subscription {
- const currentUser$ = platform.auth.getCurrentUserStream()
-
- const sub = combineLatest([
- currentUser$,
- restRequest$.pipe(distinctUntilChanged()),
- ])
- .pipe(
- map(([user, request]) =>
- user ? from(writeCurrentRequest(user, request)) : EMPTY
- ),
- audit((x) => x)
- )
- .subscribe(() => {
- // NOTE: This subscription should be kept
- })
-
- return sub
-}
diff --git a/packages/hoppscotch-common/src/helpers/rest/default.ts b/packages/hoppscotch-common/src/helpers/rest/default.ts
new file mode 100644
index 000000000..873ee2d7d
--- /dev/null
+++ b/packages/hoppscotch-common/src/helpers/rest/default.ts
@@ -0,0 +1,20 @@
+import { HoppRESTRequest, RESTReqSchemaVersion } from "@hoppscotch/data"
+
+export const getDefaultRESTRequest = (): HoppRESTRequest => ({
+ v: RESTReqSchemaVersion,
+ endpoint: "https://echo.hoppscotch.io",
+ name: "Untitled",
+ params: [],
+ headers: [],
+ method: "GET",
+ auth: {
+ authType: "none",
+ authActive: true,
+ },
+ preRequestScript: "",
+ testScript: "",
+ body: {
+ contentType: null,
+ body: null,
+ },
+})
diff --git a/packages/hoppscotch-common/src/helpers/rest/document.ts b/packages/hoppscotch-common/src/helpers/rest/document.ts
new file mode 100644
index 000000000..e80ef8e88
--- /dev/null
+++ b/packages/hoppscotch-common/src/helpers/rest/document.ts
@@ -0,0 +1,58 @@
+import { HoppRESTRequest } from "@hoppscotch/data"
+
+export type HoppRESTSaveContext =
+ | {
+ /**
+ * The origin source of the request
+ */
+ originLocation: "user-collection"
+ /**
+ * Path to the request folder
+ */
+ folderPath: string
+ /**
+ * Index to the request
+ */
+ requestIndex: number
+ }
+ | {
+ /**
+ * The origin source of the request
+ */
+ originLocation: "team-collection"
+ /**
+ * ID of the request in the team
+ */
+ requestID: string
+ /**
+ * ID of the team
+ */
+ teamID?: string
+ /**
+ * ID of the collection loaded
+ */
+ collectionID?: string
+ }
+ | null
+
+/**
+ * Defines a live 'document' (something that is open and being edited) in the app
+ */
+export type HoppRESTDocument = {
+ /**
+ * The request as it is in the document
+ */
+ request: HoppRESTRequest
+
+ /**
+ * Whether the request has any unsaved changes
+ * (atleast as far as we can say)
+ */
+ isDirty: boolean
+
+ /**
+ * Info about where this request should be saved.
+ * This contains where the request is originated from basically.
+ */
+ saveContext?: HoppRESTSaveContext
+}
diff --git a/packages/hoppscotch-common/src/helpers/rest/labelColoring.ts b/packages/hoppscotch-common/src/helpers/rest/labelColoring.ts
new file mode 100644
index 000000000..6c4f65387
--- /dev/null
+++ b/packages/hoppscotch-common/src/helpers/rest/labelColoring.ts
@@ -0,0 +1,25 @@
+import { pipe } from "fp-ts/function"
+import * as O from "fp-ts/Option"
+import * as RR from "fp-ts/ReadonlyRecord"
+import { HoppRESTRequest } from "@hoppscotch/data"
+
+export const REQUEST_METHOD_LABEL_COLORS = {
+ get: "text-green-500",
+ post: "text-yellow-500",
+ put: "text-blue-500",
+ delete: "text-red-500",
+ default: "text-gray-500",
+} as const
+
+/**
+ * Returns the label color tailwind class for a request
+ * @param request The HoppRESTRequest object to get the value for
+ * @returns The class value for the given HTTP VERB, if not, a generic verb class
+ */
+export function getMethodLabelColorClassOf(request: HoppRESTRequest) {
+ return pipe(
+ REQUEST_METHOD_LABEL_COLORS,
+ RR.lookup(request.method.toLowerCase()),
+ O.getOrElseW(() => REQUEST_METHOD_LABEL_COLORS.default)
+ )
+}
diff --git a/packages/hoppscotch-common/src/helpers/rest/tab.ts b/packages/hoppscotch-common/src/helpers/rest/tab.ts
new file mode 100644
index 000000000..31829ebb4
--- /dev/null
+++ b/packages/hoppscotch-common/src/helpers/rest/tab.ts
@@ -0,0 +1,199 @@
+import { v4 as uuidV4 } from "uuid"
+import { isEqual } from "lodash-es"
+import { reactive, watch, computed, ref, shallowReadonly } from "vue"
+import { HoppRESTDocument, HoppRESTSaveContext } from "./document"
+import { refWithControl } from "@vueuse/core"
+import { HoppRESTResponse } from "../types/HoppRESTResponse"
+import { getDefaultRESTRequest } from "./default"
+import { HoppTestResult } from "../types/HoppTestResult"
+
+export type HoppRESTTab = {
+ id: string
+ document: HoppRESTDocument
+ response?: HoppRESTResponse | null
+ testResults?: HoppTestResult | null
+}
+
+export type PersistableRESTTabState = {
+ lastActiveTabID: string
+ orderedDocs: Array<{
+ tabID: string
+ doc: HoppRESTDocument
+ }>
+}
+
+export const currentTabID = refWithControl("test", {
+ onBeforeChange(newTabID) {
+ if (!newTabID || !tabMap.has(newTabID)) {
+ console.warn(
+ `Tried to set current tab id to an invalid value. (value: ${newTabID})`
+ )
+
+ // Don't allow change
+ return false
+ }
+ },
+})
+
+const tabMap = reactive(
+ new Map<string, HoppRESTTab>([
+ [
+ "test",
+ {
+ id: "test",
+ document: {
+ request: getDefaultRESTRequest(),
+ isDirty: false,
+ },
+ },
+ ],
+ ])
+)
+const tabOrdering = ref<string[]>(["test"])
+
+watch(
+ tabOrdering,
+ (newOrdering) => {
+ if (!currentTabID.value || !newOrdering.includes(currentTabID.value)) {
+ currentTabID.value = newOrdering[newOrdering.length - 1] // newOrdering should always be non-empty
+ }
+ },
+ { deep: true }
+)
+
+export const persistableTabState = computed<PersistableRESTTabState>(() => ({
+ lastActiveTabID: currentTabID.value,
+ orderedDocs: tabOrdering.value.map((tabID) => {
+ const tab = tabMap.get(tabID)! // tab ordering is guaranteed to have value for this key
+ return {
+ tabID: tab.id,
+ doc: tab.document,
+ }
+ }),
+}))
+
+export const currentActiveTab = computed(() => tabMap.get(currentTabID.value)!) // Guaranteed to not be undefined
+
+// TODO: Mark this unknown and do validations
+export function loadTabsFromPersistedState(data: PersistableRESTTabState) {
+ if (data) {
+ tabMap.clear()
+ tabOrdering.value = []
+
+ for (const doc of data.orderedDocs) {
+ tabMap.set(doc.tabID, {
+ id: doc.tabID,
+ document: doc.doc,
+ })
+
+ tabOrdering.value.push(doc.tabID)
+ }
+
+ currentTabID.value = data.lastActiveTabID
+ }
+}
+
+/**
+ * Returns all the active Tab IDs in order
+ */
+export function getActiveTabs() {
+ return shallowReadonly(
+ computed(() => tabOrdering.value.map((x) => tabMap.get(x)!))
+ )
+}
+
+export function getTabRef(tabID: string) {
+ return computed({
+ get() {
+ const result = tabMap.get(tabID)
+
+ if (result === undefined) throw new Error(`Invalid tab id: ${tabID}`)
+
+ return result
+ },
+ set(value) {
+ return tabMap.set(tabID, value)
+ },
+ })
+}
+
+function generateNewTabID() {
+ while (true) {
+ const id = uuidV4()
+
+ if (!tabMap.has(id)) return id
+ }
+}
+
+export function updateTab(tabUpdate: HoppRESTTab) {
+ if (!tabMap.has(tabUpdate.id)) {
+ console.warn(
+ `Cannot update tab as tab with that tab id does not exist (id: ${tabUpdate.id})`
+ )
+ }
+
+ tabMap.set(tabUpdate.id, tabUpdate)
+}
+
+export function createNewTab(document: HoppRESTDocument, switchToIt = true) {
+ const id = generateNewTabID()
+
+ const tab: HoppRESTTab = { id, document }
+
+ tabMap.set(id, tab)
+ tabOrdering.value.push(id)
+
+ if (switchToIt) {
+ currentTabID.value = id
+ }
+
+ return tab
+}
+
+export function updateTabOrdering(fromIndex: number, toIndex: number) {
+ tabOrdering.value.splice(
+ toIndex,
+ 0,
+ tabOrdering.value.splice(fromIndex, 1)[0]
+ )
+}
+
+export function closeTab(tabID: string) {
+ if (!tabMap.has(tabID)) {
+ console.warn(`Tried to close a tab which does not exist (tab id: ${tabID})`)
+ return
+ }
+
+ if (tabOrdering.value.length === 1) {
+ console.warn(
+ `Tried to close the only tab open, which is not allowed. (tab id: ${tabID})`
+ )
+ return
+ }
+
+ tabOrdering.value.splice(tabOrdering.value.indexOf(tabID), 1)
+
+ tabMap.delete(tabID)
+}
+
+export function getTabRefWithSaveContext(ctx: HoppRESTSaveContext) {
+ for (const tab of tabMap.values()) {
+ // For `team-collection` request id can be considered unique
+ if (ctx && ctx.originLocation === "team-collection") {
+ if (
+ tab.document.saveContext?.originLocation === "team-collection" &&
+ tab.document.saveContext.requestID === ctx.requestID
+ ) {
+ return getTabRef(tab.id)
+ }
+ } else if (isEqual(ctx, tab.document.saveContext)) return getTabRef(tab.id)
+ }
+
+ return null
+}
+
+export function getTabsRefTo(func: (tab: HoppRESTTab) => boolean) {
+ return Array.from(tabMap.values())
+ .filter(func)
+ .map((tab) => getTabRef(tab.id))
+}
diff --git a/packages/hoppscotch-common/src/helpers/types/HoppRequestSaveContext.ts b/packages/hoppscotch-common/src/helpers/types/HoppRequestSaveContext.ts
index 014b76b39..0eddaa9e3 100644
--- a/packages/hoppscotch-common/src/helpers/types/HoppRequestSaveContext.ts
+++ b/packages/hoppscotch-common/src/helpers/types/HoppRequestSaveContext.ts
@@ -4,7 +4,7 @@ import { HoppRESTRequest } from "@hoppscotch/data"
* We use the save context to figure out
* how a loaded request is to be saved.
* These will be set when the request is loaded
- * into the request session (RESTSession)
+ * into the request session
*/
export type HoppRequestSaveContext =
| {
diff --git a/packages/hoppscotch-common/src/newstore/RESTSession.ts b/packages/hoppscotch-common/src/newstore/RESTSession.ts
deleted file mode 100644
index f1e18cf29..000000000
--- a/packages/hoppscotch-common/src/newstore/RESTSession.ts
+++ /dev/null
@@ -1,710 +0,0 @@
-import { pluck, distinctUntilChanged, map, filter } from "rxjs/operators"
-import { Ref } from "vue"
-import {
- FormDataKeyValue,
- HoppRESTHeader,
- HoppRESTParam,
- HoppRESTReqBody,
- HoppRESTRequest,
- RESTReqSchemaVersion,
- HoppRESTAuth,
- ValidContentTypes,
-} from "@hoppscotch/data"
-import DispatchingStore, { defineDispatchers } from "./DispatchingStore"
-import { HoppRESTResponse } from "~/helpers/types/HoppRESTResponse"
-import { useStream } from "@composables/stream"
-import { HoppTestResult } from "~/helpers/types/HoppTestResult"
-import { HoppRequestSaveContext } from "~/helpers/types/HoppRequestSaveContext"
-import { applyBodyTransition } from "~/helpers/rules/BodyTransition"
-
-type RESTSession = {
- request: HoppRESTRequest
- response: HoppRESTResponse | null
- testResults: HoppTestResult | null
- saveContext: HoppRequestSaveContext | null
-}
-
-export const getDefaultRESTRequest = (): HoppRESTRequest => ({
- v: RESTReqSchemaVersion,
- endpoint: "https://echo.hoppscotch.io",
- name: "Untitled request",
- params: [],
- headers: [],
- method: "GET",
- auth: {
- authType: "none",
- authActive: true,
- },
- preRequestScript: "",
- testScript: "",
- body: {
- contentType: null,
- body: null,
- },
-})
-
-const defaultRESTSession: RESTSession = {
- request: getDefaultRESTRequest(),
- response: null,
- testResults: null,
- saveContext: null,
-}
-
-const dispatchers = defineDispatchers({
- setRequest(_: RESTSession, { req }: { req: HoppRESTRequest }) {
- return {
- request: req,
- }
- },
- setRequestName(curr: RESTSession, { newName }: { newName: string }) {
- return {
- request: {
- ...curr.request,
- name: newName,
- },
- }
- },
- setEndpoint(curr: RESTSession, { newEndpoint }: { newEndpoint: string }) {
- return {
- request: {
- ...curr.request,
- endpoint: newEndpoint,
- },
- }
- },
- setParams(curr: RESTSession, { entries }: { entries: HoppRESTParam[] }) {
- return {
- request: {
- ...curr.request,
- params: entries,
- },
- }
- },
- addParam(curr: RESTSession, { newParam }: { newParam: HoppRESTParam }) {
- return {
- request: {
- ...curr.request,
- params: [...curr.request.params, newParam],
- },
- }
- },
- updateParam(
- curr: RESTSession,
- { index, updatedParam }: { index: number; updatedParam: HoppRESTParam }
- ) {
- const newParams = curr.request.params.map((param, i) => {
- if (i === index) return updatedParam
- else return param
- })
-
- return {
- request: {
- ...curr.request,
- params: newParams,
- },
- }
- },
- deleteParam(curr: RESTSession, { index }: { index: number }) {
- const newParams = curr.request.params.filter((_x, i) => i !== index)
-
- return {
- request: {
- ...curr.request,
- params: newParams,
- },
- }
- },
- deleteAllParams(curr: RESTSession, {}) {
- return {
- request: {
- ...curr.request,
- params: [],
- },
- }
- },
- updateMethod(curr: RESTSession, { newMethod }: { newMethod: string }) {
- return {
- request: {
- ...curr.request,
- method: newMethod,
- },
- }
- },
- setHeaders(curr: RESTSession, { entries }: { entries: HoppRESTHeader[] }) {
- return {
- request: {
- ...curr.request,
- headers: entries,
- },
- }
- },
- addHeader(curr: RESTSession, { entry }: { entry: HoppRESTHeader }) {
- return {
- request: {
- ...curr.request,
- headers: [...curr.request.headers, entry],
- },
- }
- },
- updateHeader(
- curr: RESTSession,
- { index, updatedEntry }: { index: number; updatedEntry: HoppRESTHeader }
- ) {
- return {
- request: {
- ...curr.request,
- headers: curr.request.headers.map((header, i) => {
- if (i === index) return updatedEntry
- else return header
- }),
- },
- }
- },
- deleteHeader(curr: RESTSession, { index }: { index: number }) {
- return {
- request: {
- ...curr.request,
- headers: curr.request.headers.filter((_, i) => i !== index),
- },
- }
- },
- deleteAllHeaders(curr: RESTSession, {}) {
- return {
- request: {
- ...curr.request,
- headers: [],
- },
- }
- },
- setAuth(curr: RESTSession, { newAuth }: { newAuth: HoppRESTAuth }) {
- return {
- request: {
- ...curr.request,
- auth: newAuth,
- },
- }
- },
- setPreRequestScript(curr: RESTSession, { newScript }: { newScript: string }) {
- return {
- request: {
- ...curr.request,
- preRequestScript: newScript,
- },
- }
- },
- setTestScript(curr: RESTSession, { newScript }: { newScript: string }) {
- return {
- request: {
- ...curr.request,
- testScript: newScript,
- },
- }
- },
- setContentType(
- curr: RESTSession,
- { newContentType }: { newContentType: ValidContentTypes | null }
- ) {
- // TODO: persist body evenafter switching content typees
- return {
- request: {
- ...curr.request,
- body: applyBodyTransition(curr.request.body, newContentType),
- },
- }
- },
- addFormDataEntry(curr: RESTSession, { entry }: { entry: FormDataKeyValue }) {
- // Only perform update if the current content-type is formdata
- if (curr.request.body.contentType !== "multipart/form-data") return {}
-
- return {
- request: {
- ...curr.request,
- body: <HoppRESTReqBody>{
- contentType: "multipart/form-data",
- body: [...curr.request.body.body, entry],
- },
- },
- }
- },
- deleteFormDataEntry(curr: RESTSession, { index }: { index: number }) {
- // Only perform update if the current content-type is formdata
- if (curr.request.body.contentType !== "multipart/form-data") return {}
-
- return {
- request: {
- ...curr.request,
- body: <HoppRESTReqBody>{
- contentType: "multipart/form-data",
- body: curr.request.body.body.filter((_, i) => i !== index),
- },
- },
- }
- },
- updateFormDataEntry(
- curr: RESTSession,
- { index, entry }: { index: number; entry: FormDataKeyValue }
- ) {
- // Only perform update if the current content-type is formdata
- if (curr.request.body.contentType !== "multipart/form-data") return {}
-
- return {
- request: {
- ...curr.request,
- body: <HoppRESTReqBody>{
- contentType: "multipart/form-data",
- body: curr.request.body.body.map((x, i) => (i !== index ? x : entry)),
- },
- },
- }
- },
- deleteAllFormDataEntries(curr: RESTSession, {}) {
- // Only perform update if the current content-type is formdata
- if (curr.request.body.contentType !== "multipart/form-data") return {}
-
- return {
- request: {
- ...curr.request,
- body: <HoppRESTReqBody>{
- contentType: "multipart/form-data",
- body: [],
- },
- },
- }
- },
- setRequestBody(curr: RESTSession, { newBody }: { newBody: HoppRESTReqBody }) {
- return {
- request: {
- ...curr.request,
- body: newBody,
- },
- }
- },
- updateResponse(
- _curr: RESTSession,
- { updatedRes }: { updatedRes: HoppRESTResponse | null }
- ) {
- return {
- response: updatedRes,
- }
- },
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
- clearResponse(_curr: RESTSession, {}) {
- return {
- response: null,
- }
- },
- setTestResults(
- _curr: RESTSession,
- { newResults }: { newResults: HoppTestResult | null }
- ) {
- return {
- testResults: newResults,
- }
- },
- setSaveContext(
- _,
- { newContext }: { newContext: HoppRequestSaveContext | null }
- ) {
- return {
- saveContext: newContext,
- }
- },
-})
-
-const restSessionStore = new DispatchingStore(defaultRESTSession, dispatchers)
-
-export function getRESTRequest() {
- return restSessionStore.subject$.value.request
-}
-
-export function setRESTRequest(
- req: HoppRESTRequest,
- saveContext?: HoppRequestSaveContext | null
-) {
- restSessionStore.dispatch({
- dispatcher: "setRequest",
- payload: {
- req,
- },
- })
-
- if (saveContext) setRESTSaveContext(saveContext)
-}
-
-export function setRESTSaveContext(saveContext: HoppRequestSaveContext | null) {
- restSessionStore.dispatch({
- dispatcher: "setSaveContext",
- payload: {
- newContext: saveContext,
- },
- })
-}
-
-export function getRESTSaveContext() {
- return restSessionStore.value.saveContext
-}
-
-export function resetRESTRequest() {
- setRESTRequest(getDefaultRESTRequest())
-}
-
-export function setRESTEndpoint(newEndpoint: string) {
- restSessionStore.dispatch({
- dispatcher: "setEndpoint",
- payload: {
- newEndpoint,
- },
- })
-}
-
-export function setRESTRequestName(newName: string) {
- restSessionStore.dispatch({
- dispatcher: "setRequestName",
- payload: {
- newName,
- },
- })
-}
-
-export function setRESTParams(entries: HoppRESTParam[]) {
- restSessionStore.dispatch({
- dispatcher: "setParams",
- payload: {
- entries,
- },
- })
-}
-
-export function addRESTParam(newParam: HoppRESTParam) {
- restSessionStore.dispatch({
- dispatcher: "addParam",
- payload: {
- newParam,
- },
- })
-}
-
-export function updateRESTParam(index: number, updatedParam: HoppRESTParam) {
- restSessionStore.dispatch({
- dispatcher: "updateParam",
- payload: {
- updatedParam,
- index,
- },
- })
-}
-
-export function deleteRESTParam(index: number) {
- restSessionStore.dispatch({
- dispatcher: "deleteParam",
- payload: {
- index,
- },
- })
-}
-
-export function deleteAllRESTParams() {
- restSessionStore.dispatch({
- dispatcher: "deleteAllParams",
- payload: {},
- })
-}
-
-export function updateRESTMethod(newMethod: string) {
- restSessionStore.dispatch({
- dispatcher: "updateMethod",
- payload: {
- newMethod,
- },
- })
-}
-
-export function setRESTHeaders(entries: HoppRESTHeader[]) {
- restSessionStore.dispatch({
- dispatcher: "setHeaders",
- payload: {
- entries,
- },
- })
-}
-
-export function addRESTHeader(entry: HoppRESTHeader) {
- restSessionStore.dispatch({
- dispatcher: "addHeader",
- payload: {
- entry,
- },
- })
-}
-
-export function updateRESTHeader(index: number, updatedEntry: HoppRESTHeader) {
- restSessionStore.dispatch({
- dispatcher: "updateHeader",
- payload: {
- index,
- updatedEntry,
- },
- })
-}
-
-export function deleteRESTHeader(index: number) {
- restSessionStore.dispatch({
- dispatcher: "deleteHeader",
- payload: {
- index,
- },
- })
-}
-
-export function deleteAllRESTHeaders() {
- restSessionStore.dispatch({
- dispatcher: "deleteAllHeaders",
- payload: {},
- })
-}
-
-export function setRESTAuth(newAuth: HoppRESTAuth) {
- restSessionStore.dispatch({
- dispatcher: "setAuth",
- payload: {
- newAuth,
- },
- })
-}
-
-export function setRESTPreRequestScript(newScript: string) {
- restSessionStore.dispatch({
- dispatcher: "setPreRequestScript",
- payload: {
- newScript,
- },
- })
-}
-
-export function setRESTTestScript(newScript: string) {
- restSessionStore.dispatch({
- dispatcher: "setTestScript",
- payload: {
- newScript,
- },
- })
-}
-
-export function setRESTReqBody(newBody: HoppRESTReqBody) {
- restSessionStore.dispatch({
- dispatcher: "setRequestBody",
- payload: {
- newBody,
- },
- })
-}
-
-export function updateRESTResponse(updatedRes: HoppRESTResponse | null) {
- restSessionStore.dispatch({
- dispatcher: "updateResponse",
- payload: {
- updatedRes,
- },
- })
-}
-
-export function clearRESTResponse() {
- restSessionStore.dispatch({
- dispatcher: "clearResponse",
- payload: {},
- })
-}
-
-export function setRESTTestResults(newResults: HoppTestResult | null) {
- restSessionStore.dispatch({
- dispatcher: "setTestResults",
- payload: {
- newResults,
- },
- })
-}
-
-export function addFormDataEntry(entry: FormDataKeyValue) {
- restSessionStore.dispatch({
- dispatcher: "addFormDataEntry",
- payload: {
- entry,
- },
- })
-}
-
-export function deleteFormDataEntry(index: number) {
- restSessionStore.dispatch({
- dispatcher: "deleteFormDataEntry",
- payload: {
- index,
- },
- })
-}
-
-export function updateFormDataEntry(index: number, entry: FormDataKeyValue) {
- restSessionStore.dispatch({
- dispatcher: "updateFormDataEntry",
- payload: {
- index,
- entry,
- },
- })
-}
-
-export function setRESTContentType(newContentType: ValidContentTypes | null) {
- restSessionStore.dispatch({
- dispatcher: "setContentType",
- payload: {
- newContentType,
- },
- })
-}
-
-export function deleteAllFormDataEntries() {
- restSessionStore.dispatch({
- dispatcher: "deleteAllFormDataEntries",
- payload: {},
- })
-}
-
-export const restSaveContext$ = restSessionStore.subject$.pipe(
- pluck("saveContext"),
- distinctUntilChanged()
-)
-
-export const restRequest$ = restSessionStore.subject$.pipe(
- pluck("request"),
- distinctUntilChanged()
-)
-
-export const restRequestName$ = restRequest$.pipe(
- pluck("name"),
- distinctUntilChanged()
-)
-
-export const restEndpoint$ = restSessionStore.subject$.pipe(
- pluck("request", "endpoint"),
- distinctUntilChanged()
-)
-
-export const restParams$ = restSessionStore.subject$.pipe(
- pluck("request", "params"),
- distinctUntilChanged()
-)
-
-export const restActiveParamsCount$ = restParams$.pipe(
- map(
- (params) =>
- params.filter((x) => x.active && (x.key !== "" || x.value !== "")).length
- )
-)
-
-export const restMethod$ = restSessionStore.subject$.pipe(
- pluck("request", "method"),
- distinctUntilChanged()
-)
-
-export const restHeaders$ = restSessionStore.subject$.pipe(
- pluck("request", "headers"),
- distinctUntilChanged()
-)
-
-export const restActiveHeadersCount$ = restHeaders$.pipe(
- map(
- (params) =>
- params.filter((x) => x.active && (x.key !== "" || x.value !== "")).length
- )
-)
-
-export const restAuth$ = restRequest$.pipe(pluck("auth"))
-
-export const restPreRequestScript$ = restSessionStore.subject$.pipe(
- pluck("request", "preRequestScript"),
- distinctUntilChanged()
-)
-
-export const restContentType$ = restRequest$.pipe(
- pluck("body", "contentType"),
- distinctUntilChanged()
-)
-
-export const restTestScript$ = restSessionStore.subject$.pipe(
- pluck("request", "testScript"),
- distinctUntilChanged()
-)
-
-export const restReqBody$ = restSessionStore.subject$.pipe(
- pluck("request", "body"),
- distinctUntilChanged()
-)
-
-export const restResponse$ = restSessionStore.subject$.pipe(
- pluck("response"),
- distinctUntilChanged()
-)
-
-export const completedRESTResponse$ = restResponse$.pipe(
- filter(
- (res) =>
- res !== null &&
- res.type !== "loading" &&
- res.type !== "network_fail" &&
- res.type !== "script_fail"
- )
-)
-
-export const restTestResults$ = restSessionStore.subject$.pipe(
- pluck("testResults"),
- distinctUntilChanged()
-)
-
-/**
- * A Vue 3 composable function that gives access to a ref
- * which is updated to the preRequestScript value in the store.
- * The ref value is kept in sync with the store and all writes
- * to the ref are dispatched to the store as `setPreRequestScript`
- * dispatches.
- */
-export function usePreRequestScript(): Ref<string> {
- return useStream(
- restPreRequestScript$,
- restSessionStore.value.request.preRequestScript,
- (value) => {
- setRESTPreRequestScript(value)
- }
- )
-}
-
-/**
- * A Vue 3 composable function that gives access to a ref
- * which is updated to the testScript value in the store.
- * The ref value is kept in sync with the store and all writes
- * to the ref are dispatched to the store as `setTestScript`
- * dispatches.
- */
-export function useTestScript(): Ref<string> {
- return useStream(
- restTestScript$,
- restSessionStore.value.request.testScript,
- (value) => {
- setRESTTestScript(value)
- }
- )
-}
-
-export function useRESTRequestBody(): Ref<HoppRESTReqBody> {
- return useStream(
- restReqBody$,
- restSessionStore.value.request.body,
- setRESTReqBody
- )
-}
-
-export function useRESTRequestName(): Ref<string> {
- return useStream(
- restRequestName$,
- restSessionStore.value.request.name,
- setRESTRequestName
- )
-}
diff --git a/packages/hoppscotch-common/src/newstore/collections.ts b/packages/hoppscotch-common/src/newstore/collections.ts
index db4b23cc5..63870627d 100644
--- a/packages/hoppscotch-common/src/newstore/collections.ts
+++ b/packages/hoppscotch-common/src/newstore/collections.ts
@@ -6,8 +6,8 @@ import {
makeCollection,
} from "@hoppscotch/data"
import DispatchingStore, { defineDispatchers } from "./DispatchingStore"
-import { getRESTSaveContext, setRESTSaveContext } from "./RESTSession"
import { cloneDeep } from "lodash-es"
+import { getTabRefWithSaveContext } from "~/helpers/rest/tab"
const defaultRESTCollectionState = {
state: [
@@ -400,14 +400,17 @@ const restCollectionDispatchers = defineDispatchers({
targetLocation.requests.splice(requestIndex, 1)
- // If the save context is set and is set to the same source, we invalidate it
- const saveCtx = getRESTSaveContext()
- if (
- saveCtx?.originLocation === "user-collection" &&
- saveCtx.folderPath === path &&
- saveCtx.requestIndex === requestIndex
- ) {
- setRESTSaveContext(null)
+ // Deal with situations where a tab with the given thing is deleted
+ // We are just going to dissociate the save context of the tab and mark it dirty
+ const tab = getTabRefWithSaveContext({
+ originLocation: "user-collection",
+ folderPath: path,
+ requestIndex: requestIndex,
+ })
+
+ if (tab) {
+ tab.value.document.saveContext = undefined
+ tab.value.document.isDirty = true
}
return {
@@ -457,6 +460,20 @@ const restCollectionDispatchers = defineDispatchers({
destLocation.requests.push(req)
targetLocation.requests.splice(requestIndex, 1)
+ const possibleTab = getTabRefWithSaveContext({
+ originLocation: "user-collection",
+ folderPath: path,
+ requestIndex,
+ })
+
+ if (possibleTab) {
+ possibleTab.value.document.saveContext = {
+ originLocation: "user-collection",
+ folderPath: destinationPath,
+ requestIndex: destLocation.requests.length - 1,
+ }
+ }
+
return {
state: newState,
}
@@ -719,16 +736,6 @@ const gqlCollectionDispatchers = defineDispatchers({
targetLocation.requests.splice(requestIndex, 1)
- // If the save context is set and is set to the same source, we invalidate it
- const saveCtx = getRESTSaveContext()
- if (
- saveCtx?.originLocation === "user-collection" &&
- saveCtx.folderPath === path &&
- saveCtx.requestIndex === requestIndex
- ) {
- setRESTSaveContext(null)
- }
-
return {
state: newState,
}
diff --git a/packages/hoppscotch-common/src/newstore/history.ts b/packages/hoppscotch-common/src/newstore/history.ts
index e4e5d53d9..1f5518221 100644
--- a/packages/hoppscotch-common/src/newstore/history.ts
+++ b/packages/hoppscotch-common/src/newstore/history.ts
@@ -8,7 +8,7 @@ import {
GQL_REQ_SCHEMA_VERSION,
} from "@hoppscotch/data"
import DispatchingStore, { defineDispatchers } from "./DispatchingStore"
-import { completedRESTResponse$ } from "./RESTSession"
+import { executedResponses$ } from "~/helpers/RequestRunner"
export type RESTHistoryEntry = {
v: number
@@ -340,36 +340,27 @@ export function removeDuplicateGraphqlHistoryEntry(id: string) {
}
// Listen to completed responses to add to history
-completedRESTResponse$.subscribe((res) => {
- if (res !== null) {
- if (
- res.type === "loading" ||
- res.type === "network_fail" ||
- res.type === "script_fail"
- )
- return
-
- addRESTHistoryEntry(
- makeRESTHistoryEntry({
- request: {
- auth: res.req.auth,
- body: res.req.body,
- endpoint: res.req.endpoint,
- headers: res.req.headers,
- method: res.req.method,
- name: res.req.name,
- params: res.req.params,
- preRequestScript: res.req.preRequestScript,
- testScript: res.req.testScript,
- v: res.req.v,
- },
- responseMeta: {
- duration: res.meta.responseDuration,
- statusCode: res.statusCode,
- },
- star: false,
- updatedOn: new Date(),
- })
- )
- }
+executedResponses$.subscribe((res) => {
+ addRESTHistoryEntry(
+ makeRESTHistoryEntry({
+ request: {
+ auth: res.req.auth,
+ body: res.req.body,
+ endpoint: res.req.endpoint,
+ headers: res.req.headers,
+ method: res.req.method,
+ name: res.req.name,
+ params: res.req.params,
+ preRequestScript: res.req.preRequestScript,
+ testScript: res.req.testScript,
+ v: res.req.v,
+ },
+ responseMeta: {
+ duration: res.meta.responseDuration,
+ statusCode: res.statusCode,
+ },
+ star: false,
+ updatedOn: new Date(),
+ })
+ )
})
diff --git a/packages/hoppscotch-common/src/newstore/localpersistence.ts b/packages/hoppscotch-common/src/newstore/localpersistence.ts
index cfde49425..40eec65cd 100644
--- a/packages/hoppscotch-common/src/newstore/localpersistence.ts
+++ b/packages/hoppscotch-common/src/newstore/localpersistence.ts
@@ -1,11 +1,9 @@
/* eslint-disable no-restricted-globals, no-restricted-syntax */
-import { clone, cloneDeep, assign, isEmpty } from "lodash-es"
+import { clone, assign, isEmpty } from "lodash-es"
import * as O from "fp-ts/Option"
import { pipe } from "fp-ts/function"
import {
- safelyExtractRESTRequest,
- translateToNewRequest,
translateToNewRESTCollection,
translateToNewGQLCollection,
Environment,
@@ -41,17 +39,16 @@ import {
setSelectedEnvironmentIndex,
selectedEnvironmentIndex$,
} from "./environments"
-import {
- getDefaultRESTRequest,
- restRequest$,
- setRESTRequest,
-} from "./RESTSession"
import { WSRequest$, setWSRequest } from "./WebSocketSession"
import { SIORequest$, setSIORequest } from "./SocketIOSession"
import { SSERequest$, setSSERequest } from "./SSESession"
import { MQTTRequest$, setMQTTRequest } from "./MQTTSession"
import { bulkApplyLocalState, localStateStore } from "./localstate"
-import { StorageLike } from "@vueuse/core"
+import { StorageLike, watchDebounced } from "@vueuse/core"
+import {
+ loadTabsFromPersistedState,
+ persistableTabState,
+} from "~/helpers/rest/tab"
function checkAndMigrateOldSettings() {
const vuexData = JSON.parse(window.localStorage.getItem("vuex") || "{}")
@@ -305,33 +302,28 @@ function setupGlobalEnvsPersistence() {
})
}
-function setupRequestPersistence() {
- const localRequest = JSON.parse(
- window.localStorage.getItem("restRequest") || "null"
- )
-
- if (localRequest) {
- const parsedLocal = translateToNewRequest(localRequest)
- setRESTRequest(
- safelyExtractRESTRequest(parsedLocal, getDefaultRESTRequest())
+// TODO: Graceful error handling ?
+export function setupRESTTabsPersistence() {
+ try {
+ const state = window.localStorage.getItem("restTabState")
+ if (state) {
+ const data = JSON.parse(state)
+ loadTabsFromPersistedState(data)
+ }
+ } catch (e) {
+ console.error(
+ `Failed parsing persisted tab state, state:`,
+ window.localStorage.getItem("restTabState")
)
}
- restRequest$.subscribe((req) => {
- const reqClone = cloneDeep(req)
- if (reqClone.body.contentType === "multipart/form-data") {
- reqClone.body.body = reqClone.body.body.map((x) => {
- if (x.isFile)
- return {
- ...x,
- isFile: false,
- value: "",
- }
- else return x
- })
- }
- window.localStorage.setItem("restRequest", JSON.stringify(reqClone))
- })
+ watchDebounced(
+ persistableTabState,
+ (state) => {
+ window.localStorage.setItem("restTabState", JSON.stringify(state))
+ },
+ { debounce: 500, deep: true }
+ )
}
export function setupLocalPersistence() {
@@ -339,7 +331,7 @@ export function setupLocalPersistence() {
setupLocalStatePersistence()
setupSettingsPersistence()
- setupRequestPersistence()
+ setupRESTTabsPersistence()
setupHistoryPersistence()
setupCollectionsPersistence()
setupGlobalEnvsPersistence()
diff --git a/packages/hoppscotch-common/src/pages/index.vue b/packages/hoppscotch-common/src/pages/index.vue
index 87ec68713..71c40add7 100644
--- a/packages/hoppscotch-common/src/pages/index.vue
+++ b/packages/hoppscotch-common/src/pages/index.vue
@@ -1,51 +1,109 @@
<template>
<AppPaneLayout layout-id="http">
<template #primary>
- <HttpRequest />
- <HttpRequestOptions />
- </template>
- <template #secondary>
- <HttpResponse />
+ <HoppSmartWindows
+ v-if="currentTabID"
+ :id="'rest_windows'"
+ v-model="currentTabID"
+ @remove-tab="removeTab"
+ @add-tab="addNewTab"
+ @sort="sortTabs"
+ >
+ <HoppSmartWindow
+ v-for="tab in tabs"
+ :id="tab.id"
+ :key="tab.id"
+ :label="tab.document.request.name"
+ :is-removable="tabs.length > 1"
+ >
+ <template #tabhead>
+ <span
+ class="font-semibold truncate text-tiny w-10"
+ :class="getMethodLabelColorClassOf(tab.document.request)"
+ >
+ {{ tab.document.request.method }}
+ </span>
+ <span class="text-green-600 mr-1" v-if="tab.document.isDirty">
+ •
+ </span>
+ <span class="truncate flex-1">
+ {{ tab.document.request.name }}
+ </span>
+ </template>
+
+ <HttpRequestTab
+ :model-value="tab"
+ @update:model-value="onTabUpdate"
+ />
+ </HoppSmartWindow>
+ </HoppSmartWindows>
</template>
<template #sidebar>
<HttpSidebar />
</template>
</AppPaneLayout>
+ <HoppSmartConfirmModal
+ :show="confirmingCloseForTabID !== null"
+ :confirm="t('modal.close_unsaved_tab')"
+ :title="t('confirm.save_unsaved_tab')"
+ @hide-modal="onCloseConfirmSaveTab"
+ @resolve="onResolveConfirmSaveTab"
+ />
+ <CollectionsSaveRequest
+ :show="savingRequest"
+ :mode="'rest'"
+ @hide-modal="onSaveModalClose"
+ />
</template>
-<script lang="ts">
-import {
- defineComponent,
- onBeforeMount,
- onBeforeUnmount,
- onMounted,
- Ref,
- ref,
- watch,
-} from "vue"
-import type { Subscription } from "rxjs"
-import {
- HoppRESTRequest,
- HoppRESTAuthOAuth2,
- safelyExtractRESTRequest,
- isEqualHoppRESTRequest,
-} from "@hoppscotch/data"
-import {
- getRESTRequest,
- setRESTRequest,
- setRESTAuth,
- restAuth$,
- getDefaultRESTRequest,
-} from "~/newstore/RESTSession"
+<script lang="ts" setup>
+import { ref, onMounted, onBeforeUnmount, watch, onBeforeMount } from "vue"
+import { safelyExtractRESTRequest } from "@hoppscotch/data"
import { translateExtURLParams } from "~/helpers/RESTExtURLParams"
-import { pluckRef } from "@composables/ref"
+import { useRoute } from "vue-router"
+import { getMethodLabelColorClassOf } from "~/helpers/rest/labelColoring"
import { useI18n } from "@composables/i18n"
-import { useStream } from "@composables/stream"
-import { useToast } from "@composables/toast"
-import { onLoggedIn } from "@composables/auth"
-import { loadRequestFromSync, startRequestSync } from "~/helpers/fb/request"
+import {
+ closeTab,
+ createNewTab,
+ currentActiveTab,
+ currentTabID,
+ getActiveTabs,
+ getTabRef,
+ HoppRESTTab,
+ loadTabsFromPersistedState,
+ persistableTabState,
+ updateTab,
+ updateTabOrdering,
+} from "~/helpers/rest/tab"
+import { getDefaultRESTRequest } from "~/helpers/rest/default"
+import { invokeAction } from "~/helpers/actions"
+import { onLoggedIn } from "~/composables/auth"
+import { platform } from "~/platform"
+import {
+ audit,
+ BehaviorSubject,
+ combineLatest,
+ EMPTY,
+ from,
+ map,
+ Subscription,
+} from "rxjs"
+import { useToast } from "~/composables/toast"
+import { PersistableRESTTabState } from "~/helpers/rest/tab"
+import { watchDebounced } from "@vueuse/core"
import { oauthRedirect } from "~/helpers/oauth"
-import { useRoute } from "vue-router"
+
+const savingRequest = ref(false)
+const confirmingCloseForTabID = ref<string | null>(null)
+
+const t = useI18n()
+const toast = useToast()
+
+const tabs = getActiveTabs()
+
+const confirmSync = ref(false)
+const tabStateForSync = ref<PersistableRESTTabState | null>(null)
function bindRequestToURLParams() {
const route = useRoute()
@@ -55,42 +113,138 @@ function bindRequestToURLParams() {
// If query params are empty, or contains code or error param (these are from Oauth Redirect)
// We skip URL params parsing
if (Object.keys(query).length === 0 || query.code || query.error) return
- setRESTRequest(
- safelyExtractRESTRequest(
- translateExtURLParams(query),
- getDefaultRESTRequest()
- )
+ currentActiveTab.value.document.request = safelyExtractRESTRequest(
+ translateExtURLParams(query),
+ getDefaultRESTRequest()
)
})
}
-function oAuthURL() {
- const auth = useStream(
- restAuth$,
- { authType: "none", authActive: true },
- setRESTAuth
- )
+const onTabUpdate = (tab: HoppRESTTab) => {
+ updateTab(tab)
+}
- const oauth2Token = pluckRef(auth as Ref<HoppRESTAuthOAuth2>, "token")
+const addNewTab = () => {
+ const tab = createNewTab({
+ request: getDefaultRESTRequest(),
+ isDirty: false,
+ })
- onBeforeMount(async () => {
- try {
- const tokenInfo = await oauthRedirect()
- if (Object.prototype.hasOwnProperty.call(tokenInfo, "access_token")) {
- if (typeof tokenInfo === "object") {
- oauth2Token.value = tokenInfo.access_token
- }
- }
+ currentTabID.value = tab.id
+}
+const sortTabs = (e: { oldIndex: number; newIndex: number }) => {
+ updateTabOrdering(e.oldIndex, e.newIndex)
+}
- // eslint-disable-next-line no-empty
- } catch (_) {}
- })
+const removeTab = (tabID: string) => {
+ const tab = getTabRef(tabID)
+
+ if (tab.value.document.isDirty) {
+ confirmingCloseForTabID.value = tabID
+ } else {
+ closeTab(tab.value.id)
+ }
+}
+
+/**
+ * This function is closed when the confirm tab is closed by some means (even saving triggers close)
+ */
+const onCloseConfirmSaveTab = () => {
+ if (!savingRequest.value && confirmingCloseForTabID.value) {
+ closeTab(confirmingCloseForTabID.value)
+ confirmingCloseForTabID.value = null
+ }
}
-function setupRequestSync(
- confirmSync: Ref<boolean>,
- requestForSync: Ref<HoppRESTRequest | null>
-) {
+/**
+ * Called when the user confirms they want to save the tab
+ */
+const onResolveConfirmSaveTab = () => {
+ if (currentActiveTab.value.document.saveContext) {
+ invokeAction("request.save")
+
+ if (confirmingCloseForTabID.value) {
+ closeTab(confirmingCloseForTabID.value)
+ confirmingCloseForTabID.value = null
+ }
+ } else {
+ savingRequest.value = true
+ }
+}
+
+/**
+ * Called when the Save Request modal is done and is closed
+ */
+const onSaveModalClose = () => {
+ savingRequest.value = false
+ if (confirmingCloseForTabID.value) {
+ closeTab(confirmingCloseForTabID.value)
+ confirmingCloseForTabID.value = null
+ }
+}
+
+watch(confirmSync, (newValue) => {
+ if (newValue) {
+ toast.show(t("confirm.sync"), {
+ duration: 0,
+ action: [
+ {
+ text: `${t("action.yes")}`,
+ onClick: (_, toastObject) => {
+ syncTabState()
+ toastObject.goAway(0)
+ },
+ },
+ {
+ text: `${t("action.no")}`,
+ onClick: (_, toastObject) => {
+ toastObject.goAway(0)
+ },
+ },
+ ],
+ })
+ }
+})
+
+const syncTabState = () => {
+ if (tabStateForSync.value) loadTabsFromPersistedState(tabStateForSync.value)
+}
+
+/**
+ * Performs sync of the REST Tab session with Firestore.
+ *
+ * @returns A subscription to the sync observable stream.
+ * Unsubscribe to stop syncing.
+ */
+function startTabStateSync(): Subscription {
+ const currentUser$ = platform.auth.getCurrentUserStream()
+ const tabState$ = new BehaviorSubject<PersistableRESTTabState | null>(null)
+
+ watchDebounced(
+ persistableTabState,
+ (state) => {
+ tabState$.next(state)
+ },
+ { debounce: 500, deep: true }
+ )
+
+ const sub = combineLatest([currentUser$, tabState$])
+ .pipe(
+ map(([user, tabState]) =>
+ user && tabState
+ ? from(platform.sync.tabState.writeCurrentTabState(user, tabState))
+ : EMPTY
+ ),
+ audit((x) => x)
+ )
+ .subscribe(() => {
+ // NOTE: This subscription should be kept
+ })
+
+ return sub
+}
+
+function setupTabStateSync() {
const route = useRoute()
// Subscription to request sync
@@ -102,16 +256,16 @@ function setupRequestSync(
Object.keys(route.query).length === 0 &&
!(route.query.code || route.query.error)
) {
- const request = await loadRequestFromSync()
- if (request) {
- if (!isEqualHoppRESTRequest(request, getRESTRequest())) {
- requestForSync.value = request
- confirmSync.value = true
- }
+ const tabStateFromSync =
+ await platform.sync.tabState.loadTabStateFromSync()
+
+ if (tabStateFromSync) {
+ tabStateForSync.value = tabStateFromSync
+ confirmSync.value = true
}
}
- sub = startRequestSync()
+ sub = startTabStateSync()
})
// Stop subscription to stop syncing
@@ -120,54 +274,28 @@ function setupRequestSync(
})
}
-export default defineComponent({
- setup() {
- const requestForSync = ref<HoppRESTRequest | null>(null)
-
- const confirmSync = ref(false)
-
- const toast = useToast()
- const t = useI18n()
-
- watch(confirmSync, (newValue) => {
- if (newValue) {
- toast.show(`${t("confirm.sync")}`, {
- duration: 0,
- action: [
- {
- text: `${t("action.yes")}`,
- onClick: (_, toastObject) => {
- syncRequest()
- toastObject.goAway(0)
- },
- },
- {
- text: `${t("action.no")}`,
- onClick: (_, toastObject) => {
- toastObject.goAway(0)
- },
- },
- ],
- })
+function oAuthURL() {
+ onBeforeMount(async () => {
+ try {
+ const tokenInfo = await oauthRedirect()
+ if (
+ typeof tokenInfo === "object" &&
+ tokenInfo.hasOwnProperty("access_token")
+ ) {
+ if (
+ currentActiveTab.value.document.request.auth.authType === "oauth-2"
+ ) {
+ currentActiveTab.value.document.request.auth.token =
+ tokenInfo.access_token
+ }
}
- })
- const syncRequest = () => {
- setRESTRequest(
- safelyExtractRESTRequest(requestForSync.value!, getDefaultRESTRequest())
- )
- }
-
- setupRequestSync(confirmSync, requestForSync)
- bindRequestToURLParams()
- oAuthURL()
+ // eslint-disable-next-line no-empty
+ } catch (_) {}
+ })
+}
- return {
- confirmSync,
- syncRequest,
- oAuthURL,
- requestForSync,
- }
- },
-})
+setupTabStateSync()
+bindRequestToURLParams()
+oAuthURL()
</script>
diff --git a/packages/hoppscotch-common/src/pages/r/_id.vue b/packages/hoppscotch-common/src/pages/r/_id.vue
index d1faa769f..a810409bb 100644
--- a/packages/hoppscotch-common/src/pages/r/_id.vue
+++ b/packages/hoppscotch-common/src/pages/r/_id.vue
@@ -71,10 +71,11 @@ import {
ResolveShortcodeQuery,
ResolveShortcodeQueryVariables,
} from "~/helpers/backend/graphql"
-import { getDefaultRESTRequest, setRESTRequest } from "~/newstore/RESTSession"
import IconHome from "~icons/lucide/home"
import IconRefreshCW from "~icons/lucide/refresh-cw"
+import { createNewTab } from "~/helpers/rest/tab"
+import { getDefaultRESTRequest } from "~/helpers/rest/default"
export default defineComponent({
setup() {
@@ -106,9 +107,10 @@ export default defineComponent({
data.right.shortcode?.request as string
)
- setRESTRequest(
- safelyExtractRESTRequest(request, getDefaultRESTRequest())
- )
+ createNewTab({
+ request: safelyExtractRESTRequest(request, getDefaultRESTRequest()),
+ isDirty: false,
+ })
router.push({ path: "/" })
}
diff --git a/packages/hoppscotch-common/src/platform/index.ts b/packages/hoppscotch-common/src/platform/index.ts
index 5894d39c8..9c8a1ff08 100644
--- a/packages/hoppscotch-common/src/platform/index.ts
+++ b/packages/hoppscotch-common/src/platform/index.ts
@@ -4,6 +4,7 @@ import { EnvironmentsPlatformDef } from "./environments"
import { CollectionsPlatformDef } from "./collections"
import { SettingsPlatformDef } from "./settings"
import { HistoryPlatformDef } from "./history"
+import { TabStatePlatformDef } from "./tab"
export type PlatformDef = {
ui?: UIPlatformDef
@@ -13,6 +14,7 @@ export type PlatformDef = {
collections: CollectionsPlatformDef
settings: SettingsPlatformDef
history: HistoryPlatformDef
+ tabState: TabStatePlatformDef
}
}
diff --git a/packages/hoppscotch-common/src/platform/tab.ts b/packages/hoppscotch-common/src/platform/tab.ts
new file mode 100644
index 000000000..ea8472fcc
--- /dev/null
+++ b/packages/hoppscotch-common/src/platform/tab.ts
@@ -0,0 +1,10 @@
+import { PersistableRESTTabState } from "~/helpers/rest/tab"
+import { HoppUser } from "./auth"
+
+export type TabStatePlatformDef = {
+ loadTabStateFromSync: () => Promise<PersistableRESTTabState | null>
+ writeCurrentTabState: (
+ user: HoppUser,
+ persistableTabState: PersistableRESTTabState
+ ) => Promise<void>
+}
diff --git a/packages/hoppscotch-ui/src/components/smart/Window.vue b/packages/hoppscotch-ui/src/components/smart/Window.vue
index ff6a82a63..0e28df2e1 100644
--- a/packages/hoppscotch-ui/src/components/smart/Window.vue
+++ b/packages/hoppscotch-ui/src/components/smart/Window.vue
@@ -1,5 +1,9 @@
<template>
- <div v-show="active" class="flex flex-col flex-1 overflow-y-auto">
+ <div
+ v-if="shouldRender"
+ v-show="active"
+ class="flex flex-col flex-1 overflow-y-auto"
+ >
<slot></slot>
</div>
</template>
@@ -27,16 +31,33 @@ const props = defineProps({
default: false,
},
})
+
const tabMeta = computed<TabMeta>(() => ({
info: props.info,
label: props.label,
isRemovable: props.isRemovable,
icon: slots.icon,
+ tabhead: slots.tabhead
}))
-const { activeTabID, addTabEntry, updateTabEntry, removeTabEntry } =
- inject<TabProvider>("tabs-system")!
+
+const {
+ activeTabID,
+ renderInactive,
+ addTabEntry,
+ updateTabEntry,
+ removeTabEntry,
+} = inject<TabProvider>("tabs-system")!
+
const active = computed(() => activeTabID.value === props.id)
+const shouldRender = computed(() => {
+ // If render inactive is true, then it should be rendered nonetheless
+ if (renderInactive.value) return true
+
+ // Else, return whatever is the active state
+ return active.value
+})
+
onMounted(() => {
addTabEntry(props.id, tabMeta.value)
})
diff --git a/packages/hoppscotch-ui/src/components/smart/Windows.vue b/packages/hoppscotch-ui/src/components/smart/Windows.vue
index 15e4cb549..d15c4bbef 100644
--- a/packages/hoppscotch-ui/src/components/smart/Windows.vue
+++ b/packages/hoppscotch-ui/src/components/smart/Windows.vue
@@ -1,8 +1,8 @@
<template>
<div class="flex flex-col flex-1 h-auto overflow-y-hidden flex-nowrap">
<div class="relative sticky top-0 z-10 flex-shrink-0 overflow-x-auto tabs bg-primaryLight">
- <div class="flex flex-1 flex-shrink-0 w-0 overflow-x-auto">
- <div class="flex justify-between divide-x divide-dividerLight">
+ <div class="flex flex-1 flex-shrink-0 w-0 overflow-x-auto" ref="scrollContainer">
+ <div class="flex justify-between divide-x divide-dividerLight" @wheel="scrollOnWindows">
<div class="flex">
<draggable v-bind="dragOptions" :list="tabEntries" :style="tabStyles" :item-key="'window-'"
class="flex flex-shrink-0 overflow-x-auto transition divide-x divide-dividerLight" @sort="sortTabs">
@@ -10,16 +10,22 @@
<button :key="`removable-tab-${tabID}`" class="tab" :class="[{ active: modelValue === tabID }]"
:aria-label="tabMeta.label || ''" role="button" @keyup.enter="selectTab(tabID)"
@click="selectTab(tabID)">
- <div class="flex items-stretch truncate">
+
+ <div v-if="!tabMeta.tabhead" class="flex items-stretch truncate">
<span v-if="tabMeta.icon" class="flex items-center justify-center mx-4 cursor-pointer">
<component :is="tabMeta.icon" class="w-4 h-4 svg-icons" />
</span>
- <span class="truncate">
+ <span class="truncate pl-4">
{{ tabMeta.label }}
</span>
</div>
+
+ <div v-else class="truncate flex items-center justify-start mx-4">
+ <component :is="tabMeta.tabhead" />
+ </div>
+
<HoppButtonSecondary v-tippy="{ theme: 'tooltip', delay: [500, 20] }" :icon="IconX" :style="{
- visibility: tabMeta.isRemovable ? 'visible' : 'hidden',
+ display: tabMeta.isRemovable ? 'flex' : 'none',
}" :title="closeText ?? t?.('action.close') ?? 'Close'"
:class="[{ active: modelValue === tabID }, 'close']" class="mx-2 !p-0.5"
@click.stop="emit('removeTab', tabID)" />
@@ -60,10 +66,13 @@ import { HoppUIPluginOptions, HOPP_UI_OPTIONS } from "./../../index"
export type TabMeta = {
label: string | null
icon: Slot | undefined
+ tabhead: Slot | undefined
info: string | null
isRemovable: boolean
}
export type TabProvider = {
+ // Whether inactive tabs should remain rendered
+ renderInactive: ComputedRef<boolean>
activeTabID: ComputedRef<string>
addTabEntry: (tabID: string, meta: TabMeta) => void
updateTabEntry: (tabID: string, newMeta: TabMeta) => void
@@ -81,6 +90,10 @@ const props = defineProps({
type: String,
required: true,
},
+ renderInactiveTabs: {
+ type: Boolean,
+ default: false,
+ },
canAddNewTab: {
type: Boolean,
default: true,
@@ -161,6 +174,7 @@ const sortTabs = (e: {
})
}
provide<TabProvider>("tabs-system", {
+ renderInactive: computed(() => props.renderInactiveTabs),
activeTabID: computed(() => props.modelValue),
addTabEntry,
updateTabEntry,
@@ -172,6 +186,14 @@ const selectTab = (id: string) => {
const addTab = () => {
emit("addTab")
}
+
+const scrollContainer = ref<HTMLElement|null>(null)
+
+const scrollOnWindows = (event: WheelEvent) => {
+ event.preventDefault()
+ if(scrollContainer.value)
+ scrollContainer.value.scrollLeft += event.deltaY
+}
</script>
<style scoped lang="scss">
diff --git a/packages/hoppscotch-ui/src/stories/Window.story.vue b/packages/hoppscotch-ui/src/stories/Window.story.vue
index aa742b7ff..e1e7f8e65 100644
--- a/packages/hoppscotch-ui/src/stories/Window.story.vue
+++ b/packages/hoppscotch-ui/src/stories/Window.story.vue
@@ -8,11 +8,32 @@
</HoppSmartWindow>
</HoppSmartWindows>
</Variant>
+ <Variant title="Custom Tab Heads">
+ <HoppSmartWindows
+ v-model="selectedWindow"
+ @add-tab="openNewTab"
+ @remove-tab="removeTab"
+ @sort="sortTabs"
+ >
+ <HoppSmartWindow
+ v-for="window in tabs"
+ :id="window.id"
+ :key="'tab_' + window.id"
+ :label="window.name"
+ :is-removable="window.removable"
+ >
+ <template #tabhead>
+ <icon-lucide-train class="svg-icons" /> <span class="truncate w-2"> - Lorem ipsum dolor sit amet</span>
+ </template>
+ </HoppSmartWindow>
+ </HoppSmartWindows>
+ </Variant>
</Story>
</template>
<script setup lang="ts">
import { HoppSmartWindows, HoppSmartWindow } from "../components/smart"
+import IconLucideTrain from "~icons/lucide/train"
import { ref } from "vue"
const selectedWindow = ref("window1")
diff --git a/packages/hoppscotch-web/src/main.ts b/packages/hoppscotch-web/src/main.ts
index 08bfbdb32..20e403d58 100644
--- a/packages/hoppscotch-web/src/main.ts
+++ b/packages/hoppscotch-web/src/main.ts
@@ -4,6 +4,7 @@ import { def as envDef } from "./environments"
import { def as collectionsDef } from "./collections"
import { def as settingsDef } from "./settings"
import { def as historyDef } from "./history"
+import { def as tabStateDef } from "./tab"
createHoppApp("#app", {
auth: authDef,
@@ -12,5 +13,6 @@ createHoppApp("#app", {
collections: collectionsDef,
settings: settingsDef,
history: historyDef,
+ tabState: tabStateDef,
},
})
diff --git a/packages/hoppscotch-web/src/tab.ts b/packages/hoppscotch-web/src/tab.ts
new file mode 100644
index 000000000..49f3da33c
--- /dev/null
+++ b/packages/hoppscotch-web/src/tab.ts
@@ -0,0 +1,48 @@
+import { PersistableRESTTabState } from "@hoppscotch/common/helpers/rest/tab"
+import { HoppUser } from "@hoppscotch/common/platform/auth"
+import { TabStatePlatformDef } from "@hoppscotch/common/platform/tab"
+import { doc, getDoc, getFirestore, setDoc } from "firebase/firestore"
+import { def as platformAuth } from "./firebase/auth"
+
+/**
+ * Writes tab state to a user's firestore sync
+ *
+ * @param persistableTabState The tab state to write to the request sync
+ */
+function writeCurrentTabState(
+ user: HoppUser,
+ persistableTabState: PersistableRESTTabState
+) {
+ // Remove FormData entries because those can't be stored on Firestore ?
+
+ return setDoc(
+ doc(getFirestore(), "users", user.uid, "requests", "tab-state"),
+ persistableTabState
+ )
+}
+
+/**
+ * Loads the synced tab state from the firestore sync
+ *
+ * @returns Fetched tab state object if exists else null
+ */
+async function loadTabStateFromSync(): Promise<PersistableRESTTabState | null> {
+ const currentUser = platformAuth.getCurrentUser()
+
+ if (!currentUser)
+ throw new Error("Cannot load request from sync without login")
+
+ const fbDoc = await getDoc(
+ doc(getFirestore(), "users", currentUser.uid, "requests", "tab-state")
+ )
+
+ const data = fbDoc.data()
+
+ if (!data) return null
+ else return data as PersistableRESTTabState
+}
+
+export const def: TabStatePlatformDef = {
+ loadTabStateFromSync,
+ writeCurrentTabState,
+}