Files
hoppscotch/pages/index.vue
2020-12-21 22:42:53 +05:30

2222 lines
74 KiB
Vue

<template>
<div class="page">
<div class="content">
<div class="page-columns inner-left">
<pw-section class="blue" :label="$t('request')" ref="request" no-legend>
<ul>
<li class="shrink">
<label for="method">{{ $t("method") }}</label>
<span class="select-wrapper">
<v-popover>
<input
id="method"
class="method"
v-model="method"
:readonly="!customMethod"
autofocus
/>
<template slot="popover">
<div
v-for="(methodMenuItem, index) in methodMenuItems"
:key="`method-${index}`"
>
<button
class="icon"
@click="
customMethod = methodMenuItem == 'CUSTOM' ? true : false
method = methodMenuItem
"
v-close-popover
>
{{ methodMenuItem }}
</button>
</div>
</template>
</v-popover>
</span>
</li>
<li>
<label for="url">{{ $t("url") }}</label>
<input
v-if="!this.$store.state.postwoman.settings.EXPERIMENTAL_URL_BAR_ENABLED"
:class="{ error: !isValidURL }"
class="border-dashed md:border-l border-brdColor"
@keyup.enter="isValidURL ? sendRequest() : null"
id="url"
name="url"
type="text"
v-model="uri"
spellcheck="false"
@input="pathInputHandler"
:placeholder="$t('url')"
/>
<url-field v-model="uri" v-else />
</li>
<li class="shrink">
<label class="hide-on-small-screen" for="send">&nbsp;</label>
<button
v-if="!runningRequest"
:disabled="!isValidURL"
@click="sendRequest"
id="send"
ref="sendButton"
>
{{ $t("send") }}
<span>
<i class="material-icons">send</i>
</span>
</button>
<button v-else @click="cancelRequest" id="send" ref="sendButton">
{{ $t("cancel") }}
<span>
<i class="material-icons">clear</i>
</span>
</button>
</li>
</ul>
<ul>
<li>
<label for="name" class="text-sm">{{ $t("token_req_name") }}</label>
<input id="name" name="name" type="text" v-model="name" class="text-sm" />
</li>
</ul>
<div label="Request Body" v-if="['POST', 'PUT', 'PATCH', 'DELETE'].includes(method)">
<ul>
<li>
<label for="contentType" class="text-sm">{{ $t("content_type") }}</label>
<autocomplete
:source="validContentTypes"
:spellcheck="false"
v-model="contentType"
styles="text-sm"
/>
</li>
</ul>
<ul>
<li>
<div class="row-wrapper">
<span>
<pw-toggle v-if="canListParameters" :on="rawInput" @change="rawInput = $event">
{{ $t("raw_input") }}
</pw-toggle>
</span>
<div>
<label for="attachment" class="p-0">
<button
class="icon"
@click="$refs.attachment.click()"
v-tooltip="
files.length === 0 ? $t('upload_file') : filenames.replace('<br/>', '')
"
>
<i class="material-icons">attach_file</i>
<span>
{{
files.length === 0
? "No files"
: files.length == 1
? "1 file"
: files.length + " files"
}}
</span>
</button>
</label>
<input
ref="attachment"
name="attachment"
type="file"
@change="uploadAttachment"
multiple
/>
<label for="payload" class="p-0">
<button
class="icon"
@click="$refs.payload.click()"
v-tooltip="$t('import_json')"
>
<i class="material-icons">post_add</i>
</button>
</label>
<input ref="payload" name="payload" type="file" @change="uploadPayload" />
<button
class="icon"
ref="prettifyRequest"
@click="prettifyRequestBody"
v-tooltip="$t('prettify_body')"
v-if="rawInput && this.contentType.endsWith('json')"
>
<i class="material-icons">photo_filter</i>
</button>
</div>
</div>
</li>
</ul>
<div v-if="!rawInput">
<ul>
<li>
<div class="row-wrapper">
<label for="reqParamList">{{ $t("parameter_list") }}</label>
<div>
<button
class="icon"
@click="clearContent('bodyParams', $event)"
v-tooltip.bottom="$t('clear')"
>
<i class="material-icons">clear_all</i>
</button>
</div>
</div>
</li>
</ul>
<ul
v-for="(param, index) in bodyParams"
:key="index"
class="border-b border-dashed divide-y md:divide-x border-brdColor divide-dashed divide-brdColor md:divide-y-0"
:class="{ 'border-t': index == 0 }"
>
<li>
<input
:placeholder="`key ${index + 1}`"
:name="`bparam ${index}`"
:value="param.key"
@change="
$store.commit('setKeyBodyParams', {
index,
value: $event.target.value,
})
"
@keyup.prevent="setRouteQueryState"
autofocus
/>
</li>
<li>
<input
:placeholder="`value ${index + 1}`"
:id="`bvalue ${index}`"
:name="'bvalue' + index"
:value="param.value"
@change="
$store.commit('setValueBodyParams', {
index,
value: $event.target.value,
})
"
@keyup.prevent="setRouteQueryState"
/>
</li>
<div>
<li>
<button
class="icon"
@click="removeRequestBodyParam(index)"
v-tooltip.bottom="$t('delete')"
id="delParam"
>
<i class="material-icons">delete</i>
</button>
</li>
</div>
</ul>
<ul>
<li>
<button class="icon" @click="addRequestBodyParam" name="addrequest">
<i class="material-icons">add</i>
<span>{{ $t("add_new") }}</span>
</button>
</li>
</ul>
</div>
<div v-else>
<ul>
<li>
<div class="row-wrapper">
<label for="rawBody">{{ $t("raw_request_body") }}</label>
<div>
<button
class="icon"
@click="clearContent('rawParams', $event)"
v-tooltip.bottom="$t('clear')"
>
<i class="material-icons">clear_all</i>
</button>
</div>
</div>
<ace-editor
v-model="rawParams"
:lang="rawInputEditorLang"
:options="{
maxLines: '16',
minLines: '8',
fontSize: '16px',
autoScrollEditorIntoView: true,
showPrintMargin: false,
useWorker: false,
}"
/>
</li>
</ul>
</div>
</div>
<div class="row-wrapper">
<span>
<button
class="icon"
id="show-modal"
@click="showCurlImportModal = !showCurlImportModal"
v-tooltip.bottom="$t('import_curl')"
>
<i class="material-icons">import_export</i>
</button>
<button
class="icon"
id="code"
@click="showCodegenModal = !showCodegenModal"
:disabled="!isValidURL"
v-tooltip.bottom="$t('show_code')"
>
<i class="material-icons">code</i>
</button>
</span>
<span>
<button
class="icon"
@click="copyRequest"
id="copyRequest"
ref="copyRequest"
:disabled="!isValidURL"
v-tooltip.bottom="$t('copy_request_link')"
>
<i v-if="navigatorShare" class="material-icons">share</i>
<i v-else class="material-icons">content_copy</i>
</button>
<button
class="icon"
@click="saveRequest"
id="saveRequest"
ref="saveRequest"
:disabled="!isValidURL"
v-tooltip.bottom="$t('save_to_collections')"
>
<i class="material-icons">create_new_folder</i>
</button>
<button
class="icon"
@click="clearContent('', $event)"
v-tooltip.bottom="$t('clear_all')"
ref="clearAll"
>
<i class="material-icons">clear_all</i>
</button>
</span>
</div>
</pw-section>
<section id="options">
<tabs>
<tab
:id="'params'"
:label="
$t('parameters') + `${params.length !== 0 ? ' \xA0 • \xA0 ' + params.length : ''}`
"
:selected="true"
>
<http-parameters
:params="params"
@clear-content="clearContent"
@remove-request-param="removeRequestParam"
@add-request-param="addRequestParam"
/>
</tab>
<tab
:id="'headers'"
:label="
$t('headers') + `${headers.length !== 0 ? ' \xA0 • \xA0 ' + headers.length : ''}`
"
>
<http-headers
:headers="headers"
@clear-content="clearContent"
@set-route-query-state="setRouteQueryState"
@remove-request-header="removeRequestHeader"
@add-request-header="addRequestHeader"
/>
</tab>
<tab :id="'authentication'" :label="$t('authentication')">
<pw-section class="teal" :label="$t('authentication')" ref="authentication" no-legend>
<ul>
<li>
<div class="row-wrapper">
<label for="auth">{{ $t("authentication") }}</label>
<div>
<button
class="icon"
@click="clearContent('auth', $event)"
v-tooltip.bottom="$t('clear')"
>
<i class="material-icons">clear_all</i>
</button>
</div>
</div>
<span class="select-wrapper">
<select id="auth" v-model="auth">
<option>None</option>
<option>Basic Auth</option>
<option>Bearer Token</option>
<option>OAuth 2.0</option>
</select>
</span>
</li>
</ul>
<ul v-if="auth === 'Basic Auth'">
<li>
<input placeholder="User" name="http_basic_user" v-model="httpUser" />
</li>
<li>
<input
placeholder="Password"
name="http_basic_passwd"
:type="passwordFieldType"
v-model="httpPassword"
/>
</li>
<div>
<li>
<button
class="icon"
id="switchVisibility"
ref="switchVisibility"
@click="switchVisibility"
>
<i class="material-icons" v-if="passwordFieldType === 'text'">visibility</i>
<i class="material-icons" v-if="passwordFieldType !== 'text'"
>visibility_off</i
>
</button>
</li>
</div>
</ul>
<ul v-if="auth === 'Bearer Token' || auth === 'OAuth 2.0'">
<li>
<div class="row-wrapper">
<input placeholder="Token" name="bearer_token" v-model="bearerToken" />
<button
v-if="auth === 'OAuth 2.0'"
class="icon"
@click="showTokenListModal = !showTokenListModal"
v-tooltip.bottom="$t('use_token')"
>
<i class="material-icons">open_in_new</i>
</button>
<button
v-if="auth === 'OAuth 2.0'"
class="icon"
@click="showTokenRequest = !showTokenRequest"
v-tooltip.bottom="$t('get_token')"
>
<i class="material-icons">vpn_key</i>
</button>
</div>
</li>
</ul>
<div class="row-wrapper">
<pw-toggle :on="!urlExcludes.auth" @change="setExclude('auth', !$event)">
{{ $t("include_in_url") }}
</pw-toggle>
</div>
</pw-section>
<pw-section
v-if="showTokenRequest"
class="red"
label="Access Token Request"
ref="accessTokenRequest"
>
<ul>
<li>
<div class="row-wrapper">
<label for="token-name">{{ $t("token_name") }}</label>
<div>
<button
class="icon"
@click="showTokenRequestList = true"
v-tooltip.bottom="$t('manage_token_req')"
>
<i class="material-icons">library_add</i>
</button>
<button
class="icon"
@click="clearContent('access_token', $event)"
v-tooltip.bottom="$t('clear')"
>
<i class="material-icons">clear_all</i>
</button>
<button
class="icon"
@click="showTokenRequest = false"
v-tooltip.bottom="$t('close')"
>
<i class="material-icons">close</i>
</button>
</div>
</div>
<input
id="token-name"
:placeholder="$t('optional')"
name="token_name"
v-model="accessTokenName"
type="text"
/>
</li>
</ul>
<ul>
<li>
<label for="oidc-discovery-url">
{{ $t("oidc_discovery_url") }}
</label>
<input
:disabled="this.authUrl !== '' || this.accessTokenUrl !== ''"
id="oidc-discovery-url"
name="oidc_discovery_url"
type="url"
v-model="oidcDiscoveryUrl"
placeholder="https://example.com/.well-known/openid-configuration"
/>
</li>
</ul>
<ul>
<li>
<label for="auth-url">{{ $t("auth_url") }}</label>
<input
:disabled="this.oidcDiscoveryUrl !== ''"
id="auth-url"
name="auth_url"
type="url"
v-model="authUrl"
placeholder="https://example.com/login/oauth/authorize"
/>
</li>
</ul>
<ul>
<li>
<label for="access-token-url">
{{ $t("access_token_url") }}
</label>
<input
:disabled="this.oidcDiscoveryUrl !== ''"
id="access-token-url"
name="access_token_url"
type="url"
v-model="accessTokenUrl"
placeholder="https://example.com/login/oauth/access_token"
/>
</li>
</ul>
<ul>
<li>
<label for="client-id">{{ $t("client_id") }}</label>
<input
id="client-id"
name="client_id"
type="text"
v-model="clientId"
placeholder="Client ID"
/>
</li>
</ul>
<ul>
<li>
<label for="scope">{{ $t("scope") }}</label>
<input
id="scope"
name="scope"
type="text"
v-model="scope"
placeholder="e.g. read:org"
/>
</li>
</ul>
<ul>
<li>
<button class="icon" @click="handleAccessTokenRequest">
<i class="material-icons">vpn_key</i>
<span>{{ $t("request_token") }}</span>
</button>
</li>
</ul>
</pw-section>
</tab>
<tab :id="'pre_request_script'" :label="$t('pre_request_script')">
<pw-section
v-if="showPreRequestScript"
class="orange"
:label="$t('pre_request_script')"
ref="preRequest"
no-legend
>
<ul>
<li>
<div class="row-wrapper">
<label for="generatedCode">{{ $t("javascript_code") }}</label>
<div>
<a
href="https://github.com/hoppscotch/hoppscotch/wiki/Pre-Request-Scripts"
target="_blank"
rel="noopener"
>
<button class="icon" v-tooltip="$t('wiki')">
<i class="material-icons">help_outline</i>
</button>
</a>
</div>
</div>
<js-editor
v-model="preRequestScript"
:options="{
maxLines: '16',
minLines: '8',
fontSize: '16px',
autoScrollEditorIntoView: true,
showPrintMargin: false,
useWorker: false,
}"
styles="rounded-b-lg"
/>
</li>
</ul>
</pw-section>
</tab>
<tab :id="'tests'" :label="$t('tests')">
<pw-section
v-if="testsEnabled"
class="orange"
:label="$t('tests')"
ref="postRequestTests"
no-legend
>
<ul>
<li>
<div class="row-wrapper">
<label for="generatedCode">{{ $t("javascript_code") }}</label>
<div>
<a
href="https://github.com/hoppscotch/hoppscotch/wiki/Post-Request-Tests"
target="_blank"
rel="noopener"
>
<button class="icon" v-tooltip="$t('wiki')">
<i class="material-icons">help_outline</i>
</button>
</a>
</div>
</div>
<js-editor
v-model="testScript"
:options="{
maxLines: '16',
minLines: '8',
fontSize: '16px',
autoScrollEditorIntoView: true,
showPrintMargin: false,
useWorker: false,
}"
styles="rounded-b-lg"
/>
<div v-if="testReports.length !== 0">
<div class="row-wrapper">
<label>Test Reports</label>
<div>
<button
class="icon"
@click="clearContent('tests', $event)"
v-tooltip.bottom="$t('clear')"
>
<i class="material-icons">clear_all</i>
</button>
</div>
</div>
<div v-for="(testReport, index) in testReports" :key="index">
<div v-if="testReport.startBlock" class="info">
<hr />
<h4>{{ testReport.startBlock }}</h4>
</div>
<p v-else-if="testReport.result" class="row-wrapper info">
<span :class="testReport.styles.class">
<i class="material-icons">
{{ testReport.styles.icon }}
</i>
<span>&nbsp; {{ testReport.result }}</span>
<span v-if="testReport.message">
<label>&nbsp; • &nbsp; {{ testReport.message }}</label>
</span>
</span>
</p>
<div v-else-if="testReport.endBlock"><hr /></div>
</div>
</div>
</li>
</ul>
</pw-section>
</tab>
</tabs>
</section>
<pw-section class="purple" id="response" :label="$t('response')" ref="response">
<ul>
<li>
<label for="status">{{ $t("status") }}</label>
<input
:class="[
statusCategory ? statusCategory.className : '',
response.status ? '' : 'rounded-b-lg',
]"
:value="response.status || $t('waiting_send_req')"
ref="status"
id="status"
name="status"
readonly
type="text"
/>
</li>
</ul>
<div v-if="response.body && response.body !== $t('loading')">
<response-body-renderer :response="response" />
</div>
</pw-section>
</div>
<aside v-if="activeSidebar" class="sticky-inner inner-right lg:max-w-md">
<section>
<tabs>
<tab :id="'history'" :label="$t('history')" :selected="true">
<history @useHistory="handleUseHistory" ref="historyComponent" />
</tab>
<tab :id="'collections'" :label="$t('collections')">
<collections />
</tab>
<tab :id="'env'" :label="$t('environments')">
<environments @use-environment="useSelectedEnvironment($event)" />
</tab>
<tab :id="'notes'" :label="$t('notes')">
<notes />
</tab>
</tabs>
</section>
</aside>
</div>
<save-request-as
:show="showSaveRequestModal"
@hide-modal="hideRequestModal"
:editing-request="editRequest"
/>
<import-curl
:show="showCurlImportModal"
@hide-modal="showCurlImportModal = false"
@handle-import="handleImport"
/>
<codegen-modal
:show="showCodegenModal"
:requestTypeProp="requestType"
:requestCode="requestCode"
@hide-modal="showCodegenModal = false"
@set-request-type="setRequestType"
/>
<token-list
:show="showTokenListModal"
:tokens="tokens"
@clear-content="clearContent"
@use-oauth-token="useOAuthToken"
@remove-oauth-token="removeOAuthToken"
@hide-modal="showTokenListModal = false"
/>
<modal v-if="showTokenRequestList" @close="showTokenRequestList = false">
<div slot="header">
<div class="row-wrapper">
<h3 class="title">{{ $t("manage_token_req") }}</h3>
<div>
<button class="icon" @click="showTokenRequestList = false">
<i class="material-icons">close</i>
</button>
</div>
</div>
</div>
<div slot="body" class="flex flex-col">
<div class="row-wrapper">
<label for="token-req-list">{{ $t("token_req_list") }}</label>
<div>
<button
:disabled="this.tokenReqs.length === 0"
class="icon"
@click="showTokenRequestList = false"
v-tooltip.bottom="$t('use_token_req')"
>
<i class="material-icons">input</i>
</button>
<button
:disabled="this.tokenReqs.length === 0"
class="icon"
@click="removeOAuthTokenReq"
v-tooltip.bottom="$t('delete')"
>
<i class="material-icons">delete</i>
</button>
</div>
</div>
<ul>
<li>
<span class="select-wrapper">
<select
id="token-req-list"
v-model="tokenReqSelect"
:disabled="this.tokenReqs.length === 0"
@change="tokenReqChange($event)"
>
<option v-for="(req, index) in tokenReqs" :key="index" :value="req.name">
{{ req.name }}
</option>
</select>
</span>
</li>
</ul>
<label for="token-req-name">{{ $t("token_req_name") }}</label>
<input v-model="tokenReqName" />
<label for="token-req-details">
{{ $t("token_req_details") }}
</label>
<textarea id="token-req-details" readonly rows="7" v-model="tokenReqDetails"></textarea>
</div>
<div slot="footer">
<div class="row-wrapper">
<span></span>
<span>
<button class="icon primary" @click="addOAuthTokenReq">
{{ $t("save_token_req") }}
</button>
</span>
</div>
</div>
</modal>
</div>
</template>
<script>
import url from "url"
import querystring from "querystring"
import parseCurlCommand from "~/helpers/curlparser"
import getEnvironmentVariablesFromScript from "~/helpers/preRequest"
import runTestScriptWithVariables from "~/helpers/postwomanTesting"
import parseTemplateString from "~/helpers/templating"
import { tokenRequest, oauthRedirect } from "~/helpers/oauth"
import { cancelRunningRequest, sendNetworkRequest } from "~/helpers/network"
import { fb } from "~/helpers/fb"
import { getEditorLangForMimeType } from "~/helpers/editorutils"
import { hasPathParams, addPathParamsToVariables, getQueryParams } from "~/helpers/requestParams"
import { parseUrlAndPath } from "~/helpers/utils/uri"
import { httpValid } from "~/helpers/utils/valid"
import { knownContentTypes, isJSONContentType } from "~/helpers/utils/contenttypes"
import { generateCodeWithGenerator } from "~/helpers/codegen/codegen"
import findStatusGroup from "~/helpers/findStatusGroup"
export default {
data() {
return {
showCurlImportModal: false,
showPreRequestScript: true,
testsEnabled: true,
testScript: "// pw.expect('variable').toBe('value');",
preRequestScript: "// pw.env.set('variable', 'value');",
testReports: [],
copyButton: '<i class="material-icons">content_copy</i>',
downloadButton: '<i class="material-icons">save_alt</i>',
doneButton: '<i class="material-icons">done</i>',
showCodegenModal: false,
response: {
status: "",
headers: "",
body: "",
},
validContentTypes: knownContentTypes,
paramsWatchEnabled: true,
showTokenListModal: false,
showTokenRequest: false,
showTokenRequestList: false,
showSaveRequestModal: false,
editRequest: {},
urlExcludes: {},
activeSidebar: true,
fb,
customMethod: false,
files: [],
filenames: "",
navigatorShare: navigator.share,
runningRequest: false,
settings: {
SCROLL_INTO_ENABLED:
typeof this.$store.state.postwoman.settings.SCROLL_INTO_ENABLED !== "undefined"
? this.$store.state.postwoman.settings.SCROLL_INTO_ENABLED
: true,
},
currentMethodIndex: 0,
methodMenuItems: [
"GET",
"HEAD",
"POST",
"PUT",
"DELETE",
"CONNECT",
"OPTIONS",
"TRACE",
"PATCH",
"CUSTOM",
],
}
},
watch: {
urlExcludes: {
deep: true,
handler() {
this.$store.commit("postwoman/applySetting", [
"URL_EXCLUDES",
Object.assign({}, this.urlExcludes),
])
},
},
canListParameters: {
immediate: true,
handler(canListParameters) {
if (canListParameters) {
this.$nextTick(() => {
this.rawInput = Boolean(this.rawParams && this.rawParams !== "{}")
})
} else {
this.rawInput = true
}
},
},
contentType(contentType, oldContentType) {
const getDefaultParams = (contentType) => {
if (isJSONContentType(contentType)) return "{}"
switch (contentType) {
case "application/xml":
return "<?xml version='1.0' encoding='utf-8'?>"
case "text/html":
return "<!doctype html>"
}
return ""
}
if (!this.rawParams || this.rawParams === getDefaultParams(oldContentType)) {
this.rawParams = getDefaultParams(contentType)
}
this.setRouteQueryState()
},
params: {
handler(newValue) {
if (!this.paramsWatchEnabled) {
this.paramsWatchEnabled = true
return
}
let path = this.path
let queryString = getQueryParams(newValue)
.map(({ key, value }) => `${key}=${value}`)
.join("&")
queryString = queryString === "" ? "" : `?${queryString}`
if (path.includes("?")) {
path = path.slice(0, path.indexOf("?")) + queryString
} else {
path = path + queryString
}
this.path = path
this.setRouteQueryState()
},
deep: true,
},
selectedRequest(newValue, oldValue) {
// @TODO: Convert all variables to single request variable
if (!newValue) return
this.uri = newValue.url + newValue.path
this.url = newValue.url
this.path = newValue.path
this.method = newValue.method
this.auth = newValue.auth
this.httpUser = newValue.httpUser
this.httpPassword = newValue.httpPassword
this.passwordFieldType = newValue.passwordFieldType
this.bearerToken = newValue.bearerToken
this.headers = newValue.headers
this.params = newValue.params
this.bodyParams = newValue.bodyParams
this.rawParams = newValue.rawParams
this.rawInput = newValue.rawInput
this.contentType = newValue.contentType
this.requestType = newValue.requestType
if (newValue.preRequestScript) {
this.showPreRequestScript = true
this.preRequestScript = newValue.preRequestScript
}
if (newValue.testScript) {
this.testsEnabled = true
this.testScript = newValue.testScript
}
this.name = newValue.name
},
editingRequest(newValue) {
this.editRequest = newValue
this.showSaveRequestModal = true
},
method() {
this.contentType = ["POST", "PUT", "PATCH", "DELETE"].includes(this.method)
? "application/json"
: ""
},
preRequestScript(val, oldVal) {
this.uri = this.uri
},
},
computed: {
/**
* Check content types that can be automatically
* serialized by postwoman.
*/
canListParameters() {
return (
this.contentType === "application/x-www-form-urlencoded" ||
isJSONContentType(this.contentType)
)
},
uri: {
get() {
return this.$store.state.request.uri ? this.$store.state.request.uri : this.url + this.path
},
set(value) {
this.$store.commit("setState", { value, attribute: "uri" })
let url = value
if ((this.preRequestScript && this.showPreRequestScript) || hasPathParams(this.params)) {
let environmentVariables = getEnvironmentVariablesFromScript(this.preRequestScript)
environmentVariables = addPathParamsToVariables(this.params, environmentVariables)
url = parseTemplateString(value, environmentVariables)
}
let result = parseUrlAndPath(url)
this.url = result.url
this.path = result.path
},
},
url: {
get() {
return this.$store.state.request.url
},
set(value) {
this.$store.commit("setState", { value, attribute: "url" })
},
},
method: {
get() {
return this.$store.state.request.method
},
set(value) {
this.$store.commit("setState", { value, attribute: "method" })
},
},
path: {
get() {
return this.$store.state.request.path
},
set(value) {
this.$store.commit("setState", { value, attribute: "path" })
},
},
name: {
get() {
return this.$store.state.request.name
},
set(value) {
this.$store.commit("setState", { value, attribute: "name" })
},
},
auth: {
get() {
return this.$store.state.request.auth
},
set(value) {
this.$store.commit("setState", { value, attribute: "auth" })
},
},
httpUser: {
get() {
return this.$store.state.request.httpUser
},
set(value) {
this.$store.commit("setState", { value, attribute: "httpUser" })
},
},
httpPassword: {
get() {
return this.$store.state.request.httpPassword
},
set(value) {
this.$store.commit("setState", { value, attribute: "httpPassword" })
},
},
bearerToken: {
get() {
return this.$store.state.request.bearerToken
},
set(value) {
this.$store.commit("setState", { value, attribute: "bearerToken" })
},
},
tokens: {
get() {
return this.$store.state.oauth2.tokens
},
set(value) {
this.$store.commit("setOAuth2", { value, attribute: "tokens" })
},
},
tokenReqs: {
get() {
return this.$store.state.oauth2.tokenReqs
},
set(value) {
this.$store.commit("setOAuth2", { value, attribute: "tokenReqs" })
},
},
tokenReqSelect: {
get() {
return this.$store.state.oauth2.tokenReqSelect
},
set(value) {
this.$store.commit("setOAuth2", { value, attribute: "tokenReqSelect" })
},
},
tokenReqName: {
get() {
return this.$store.state.oauth2.tokenReqName
},
set(value) {
this.$store.commit("setOAuth2", { value, attribute: "tokenReqName" })
},
},
accessTokenName: {
get() {
return this.$store.state.oauth2.accessTokenName
},
set(value) {
this.$store.commit("setOAuth2", {
value,
attribute: "accessTokenName",
})
},
},
oidcDiscoveryUrl: {
get() {
return this.$store.state.oauth2.oidcDiscoveryUrl
},
set(value) {
this.$store.commit("setOAuth2", {
value,
attribute: "oidcDiscoveryUrl",
})
},
},
authUrl: {
get() {
return this.$store.state.oauth2.authUrl
},
set(value) {
this.$store.commit("setOAuth2", { value, attribute: "authUrl" })
},
},
accessTokenUrl: {
get() {
return this.$store.state.oauth2.accessTokenUrl
},
set(value) {
this.$store.commit("setOAuth2", { value, attribute: "accessTokenUrl" })
},
},
clientId: {
get() {
return this.$store.state.oauth2.clientId
},
set(value) {
this.$store.commit("setOAuth2", { value, attribute: "clientId" })
},
},
scope: {
get() {
return this.$store.state.oauth2.scope
},
set(value) {
this.$store.commit("setOAuth2", { value, attribute: "scope" })
},
},
state: {
get() {
return this.$store.state.oauth2.state
},
set(value) {
this.$store.commit("setOAuth2", { value, attribute: "state" })
},
},
headers: {
get() {
return this.$store.state.request.headers
},
set(value) {
this.$store.commit("setState", { value, attribute: "headers" })
},
},
params: {
get() {
return this.$store.state.request.params
},
set(value) {
this.$store.commit("setState", { value, attribute: "params" })
},
},
bodyParams: {
get() {
return this.$store.state.request.bodyParams
},
set(value) {
this.$store.commit("setState", { value, attribute: "bodyParams" })
},
},
rawParams: {
get() {
return this.$store.state.request.rawParams
},
set(value) {
this.$store.commit("setState", { value, attribute: "rawParams" })
},
},
rawInput: {
get() {
return this.$store.state.request.rawInput
},
set(value) {
this.$store.commit("setState", { value, attribute: "rawInput" })
},
},
rawInputEditorLang() {
return getEditorLangForMimeType(this.contentType)
},
requestType: {
get() {
return this.$store.state.request.requestType
},
set(value) {
this.$store.commit("setState", { value, attribute: "requestType" })
},
},
contentType: {
get() {
return this.$store.state.request.contentType
},
set(value) {
this.$store.commit("setState", { value, attribute: "contentType" })
},
},
passwordFieldType: {
get() {
return this.$store.state.request.passwordFieldType
},
set(value) {
this.$store.commit("setState", {
value,
attribute: "passwordFieldType",
})
},
},
selectedRequest() {
return this.$store.state.postwoman.selectedRequest
},
editingRequest() {
return this.$store.state.postwoman.editingRequest
},
requestName() {
return this.name
},
statusCategory() {
return findStatusGroup(this.response.status)
},
isValidURL() {
// if showPreRequestScript, we cannot determine if a URL is valid because the full string is not known ahead of time
return this.showPreRequestScript || httpValid(this.url)
},
hasRequestBody() {
return ["POST", "PUT", "PATCH", "DELETE"].includes(this.method)
},
pathName() {
return this.path.match(/^([^?]*)\??/)[1]
},
rawRequestBody() {
const { bodyParams, contentType } = this
if (isJSONContentType(contentType)) {
try {
const obj = JSON.parse(
`{${bodyParams
.filter(({ key }) => !!key)
.map(
({ key, value }) => `
"${key}": "${value}"
`
)
.join()}}`
)
return JSON.stringify(obj, null, 2)
} catch (ex) {
console.log(ex)
this.$toast.clear()
this.$toast.error(
"Parameter value must be a string, switch to Raw input for other formats",
{
icon: "error",
}
)
return "invalid"
}
} else {
return bodyParams
.filter(({ key }) => !!key)
.map(({ key, value }) => `${key}=${encodeURIComponent(value)}`)
.join("&")
}
},
headerString() {
const result = this.headers
.filter(({ key }) => !!key)
.map(({ key, value }) => `${key}: ${value}`)
.join(",\n")
return result === "" ? "" : `${result}`
},
queryString() {
const result = getQueryParams(this.params)
.map(({ key, value }) => `${key}=${encodeURIComponent(value)}`)
.join("&")
return result === "" ? "" : `?${result}`
},
responseType() {
return (this.response.headers["content-type"] || "").split(";")[0].toLowerCase()
},
requestCode() {
let headers = []
if (this.preRequestScript || hasPathParams(this.params)) {
let environmentVariables = getEnvironmentVariablesFromScript(this.preRequestScript)
environmentVariables = addPathParamsToVariables(this.params, environmentVariables)
for (let k of this.headers) {
const kParsed = parseTemplateString(k.key, environmentVariables)
const valParsed = parseTemplateString(k.value, environmentVariables)
headers.push({ key: kParsed, value: valParsed })
}
}
return generateCodeWithGenerator(this.requestType, {
auth: this.auth,
method: this.method,
url: this.url,
pathName: this.pathName,
queryString: this.queryString,
httpUser: this.httpUser,
httpPassword: this.httpPassword,
bearerToken: this.bearerToken,
headers,
rawInput: this.rawInput,
rawParams: this.rawParams,
rawRequestBody: this.rawRequestBody,
contentType: this.contentType,
})
},
tokenReqDetails() {
const details = {
oidcDiscoveryUrl: this.oidcDiscoveryUrl,
authUrl: this.authUrl,
accessTokenUrl: this.accessTokenUrl,
clientId: this.clientId,
scope: this.scope,
}
return JSON.stringify(details, null, 2)
},
},
methods: {
useSelectedEnvironment(args) {
let environment = args.environment
let environments = args.environments
let preRequestScriptString = ""
for (let variable of environment.variables) {
preRequestScriptString += `pw.env.set('${variable.key}', '${variable.value}');\n`
}
for (let env of environments) {
if (env.name === environment.name) {
continue
}
if (env.name === "Globals" || env.name === "globals") {
preRequestScriptString += this.useSelectedEnvironment({
environment: env,
environments,
})
}
}
this.preRequestScript = preRequestScriptString
this.showPreRequestScript = true
return preRequestScriptString
},
checkCollections() {
const checkCollectionAvailability =
this.$store.state.postwoman.collections &&
this.$store.state.postwoman.collections.length > 0
return checkCollectionAvailability
},
scrollInto(view) {
this.$refs[view].$el.scrollIntoView({
behavior: "smooth",
})
},
handleUseHistory(entry) {
this.name = entry.name
this.method = entry.method
this.uri = entry.url + entry.path
this.url = entry.url
this.path = entry.path
this.showPreRequestScript = entry.usesPreScripts
this.preRequestScript = entry.preRequestScript
this.auth = entry.auth
this.httpUser = entry.httpUser
this.httpPassword = entry.httpPassword
this.bearerToken = entry.bearerToken
this.headers = entry.headers
this.params = entry.params
this.bodyParams = entry.bodyParams
this.rawParams = entry.rawParams
this.rawInput = entry.rawInput
this.contentType = entry.contentType
this.requestType = entry.requestType
this.testScript = entry.testScript
this.testsEnabled = entry.usesPostScripts
if (this.settings.SCROLL_INTO_ENABLED) this.scrollInto("request")
},
async makeRequest(auth, headers, requestBody, preRequestScript) {
const requestOptions = {
method: this.method,
url: this.url + this.pathName + this.queryString,
auth,
headers,
data: requestBody,
credentials: true,
}
if (preRequestScript || hasPathParams(this.params)) {
let environmentVariables = getEnvironmentVariablesFromScript(preRequestScript)
environmentVariables = addPathParamsToVariables(this.params, environmentVariables)
requestOptions.url = parseTemplateString(requestOptions.url, environmentVariables)
requestOptions.data = parseTemplateString(requestOptions.data, environmentVariables)
for (let k in requestOptions.headers) {
const kParsed = parseTemplateString(k, environmentVariables)
const valParsed = parseTemplateString(requestOptions.headers[k], environmentVariables)
delete requestOptions.headers[k]
requestOptions.headers[kParsed] = valParsed
}
}
if (typeof requestOptions.data === "string") {
requestOptions.data = parseTemplateString(requestOptions.data)
}
return await sendNetworkRequest(requestOptions, this.$store)
},
cancelRequest() {
cancelRunningRequest(this.$store)
},
async sendRequest() {
this.$toast.clear()
if (this.settings.SCROLL_INTO_ENABLED) this.scrollInto("response")
if (!this.isValidURL) {
this.$toast.error(this.$t("url_invalid_format"), {
icon: "error",
})
return
}
// Start showing the loading bar as soon as possible.
// The nuxt axios module will hide it when the request is made.
this.$nuxt.$loading.start()
this.previewEnabled = false
this.response.status = this.$t("fetching")
this.response.body = this.$t("loading")
const auth =
this.auth === "Basic Auth"
? {
username: this.httpUser,
password: this.httpPassword,
}
: null
let headers = {}
let headersObject = {}
Object.keys(headers).forEach((id) => {
if (headers[id].key) headersObject[headers[id].key] = headers[id].value
})
headers = headersObject
// If the request has a body, we want to ensure Content-Type is sent.
let requestBody
if (this.hasRequestBody) {
requestBody = this.rawInput ? this.rawParams : this.rawRequestBody
Object.assign(headers, {
"Content-Type": `${this.contentType}; charset=utf-8`,
})
}
requestBody = requestBody ? requestBody.toString() : null
if (this.files.length !== 0) {
const formData = new FormData()
for (let i = 0; i < this.files.length; i++) {
let file = this.files[i]
formData.append(i, file)
}
formData.append("data", requestBody)
requestBody = formData
}
// If the request uses a token for auth, we want to make sure it's sent here.
if (this.auth === "Bearer Token" || this.auth === "OAuth 2.0")
headers["Authorization"] = `Bearer ${this.bearerToken}`
headers = Object.assign(
// Clone the app headers object first, we don't want to
// mutate it with the request headers added by default.
Object.assign({}, this.headers)
// We make our temporary headers object the source so
// that you can override the added headers if you
// specify them.
// headers
)
Object.keys(headers).forEach((id) => {
if (headers[id].key) headersObject[headers[id].key] = headers[id].value
})
headers = headersObject
try {
const startTime = Date.now()
this.runningRequest = true
const payload = await this.makeRequest(
auth,
headers,
requestBody,
this.showPreRequestScript && this.preRequestScript
)
this.runningRequest = false
const duration = Date.now() - startTime
this.$toast.info(this.$t("finished_in", { duration }), {
icon: "done",
})
;(() => {
this.response.status = payload.status
this.response.headers = payload.headers
// We don't need to bother parsing JSON, axios already handles it for us!
this.response.body = payload.data
// Addition of an entry to the history component.
const entry = {
name: this.requestName,
status: this.response.status,
date: new Date().toLocaleDateString(),
time: new Date().toLocaleTimeString(),
method: this.method,
url: this.url,
path: this.path,
usesPreScripts: this.showPreRequestScript,
preRequestScript: this.preRequestScript,
duration,
star: false,
auth: this.auth,
httpUser: this.httpUser,
httpPassword: this.httpPassword,
bearerToken: this.bearerToken,
headers: this.headers,
params: this.params,
bodyParams: this.bodyParams,
rawParams: this.rawParams,
rawInput: this.rawInput,
contentType: this.contentType,
requestType: this.requestType,
testScript: this.testScript,
usesPostScripts: this.testsEnabled,
}
if ((this.preRequestScript && this.showPreRequestScript) || hasPathParams(this.params)) {
let environmentVariables = getEnvironmentVariablesFromScript(this.preRequestScript)
environmentVariables = addPathParamsToVariables(this.params, environmentVariables)
entry.path = parseTemplateString(entry.path, environmentVariables)
entry.url = parseTemplateString(entry.url, environmentVariables)
}
this.$refs.historyComponent.addEntry(entry)
if (fb.currentUser !== null) {
if (fb.currentSettings[2].value) {
fb.writeHistory(entry)
}
}
})()
} catch (error) {
this.runningRequest = false
// If the error is caused by cancellation, do nothing
if (error === "cancellation") {
this.response.status = this.$t("cancelled")
this.response.body = this.$t("cancelled")
} else {
console.log(error)
if (error.response) {
this.response.headers = error.response.headers
this.response.status = error.response.status
this.response.body = error.response.data
// Addition of an entry to the history component.
const entry = {
name: this.requestName,
status: this.response.status,
date: new Date().toLocaleDateString(),
time: new Date().toLocaleTimeString(),
method: this.method,
url: this.url,
path: this.path,
usesPreScripts: this.showPreRequestScript,
preRequestScript: this.preRequestScript,
star: false,
auth: this.auth,
httpUser: this.httpUser,
httpPassword: this.httpPassword,
bearerToken: this.bearerToken,
headers: this.headers,
params: this.params,
bodyParams: this.bodyParams,
rawParams: this.rawParams,
rawInput: this.rawInput,
contentType: this.contentType,
requestType: this.requestType,
testScript: this.testScript,
usesPostScripts: this.testsEnabled,
}
if (
(this.preRequestScript && this.showPreRequestScript) ||
hasPathParams(this.params)
) {
let environmentVariables = getEnvironmentVariablesFromScript(this.preRequestScript)
environmentVariables = addPathParamsToVariables(this.params, environmentVariables)
entry.path = parseTemplateString(entry.path, environmentVariables)
entry.url = parseTemplateString(entry.url, environmentVariables)
}
this.$refs.historyComponent.addEntry(entry)
if (fb.currentUser !== null) {
if (fb.currentSettings[2].value) {
fb.writeHistory(entry)
}
}
return
} else {
this.response.status = error.message
this.response.body = `${error}. ${this.$t("check_console_details")}`
this.$toast.error(`${error} ${this.$t("f12_details")}`, {
icon: "error",
})
if (!this.$store.state.postwoman.settings.PROXY_ENABLED) {
this.$toast.info(this.$t("enable_proxy"), {
icon: "help",
duration: 8000,
action: {
text: this.$t("yes"),
onClick: (e, toastObject) => {
this.$router.push({ path: "/settings" })
},
},
})
}
}
}
}
// tests
const syntheticResponse = {
status: this.response.status,
body: this.response.body,
headers: this.response.headers,
}
// Parse JSON body
if (
syntheticResponse.headers["content-type"] &&
isJSONContentType(syntheticResponse.headers["content-type"])
) {
try {
syntheticResponse.body = JSON.parse(
new TextDecoder("utf-8").decode(new Uint8Array(syntheticResponse.body))
)
} catch (_e) {}
}
const { testResults } = runTestScriptWithVariables(this.testScript, {
response: syntheticResponse,
})
this.testReports = testResults
},
getQueryStringFromPath() {
const pathParsed = url.parse(this.uri)
return pathParsed.query ? pathParsed.query : ""
},
queryStringToArray(queryString) {
const queryParsed = querystring.parse(queryString)
return Object.keys(queryParsed).map((key) => ({
key,
value: queryParsed[key],
}))
},
pathInputHandler() {
if (this.uri.includes("?")) {
const queryString = this.getQueryStringFromPath()
const params = this.queryStringToArray(queryString)
this.paramsWatchEnabled = false
this.params = params
}
},
addRequestHeader() {
this.$store.commit("addHeaders", {
key: "",
value: "",
})
return false
},
removeRequestHeader(index) {
// .slice() gives us an entirely new array rather than giving us just the reference
const oldHeaders = this.headers.slice()
this.$store.commit("removeHeaders", index)
this.$toast.error(this.$t("deleted"), {
icon: "delete",
action: {
text: this.$t("undo"),
onClick: (e, toastObject) => {
this.headers = oldHeaders
toastObject.remove()
},
},
})
},
addRequestParam() {
this.$store.commit("addParams", { key: "", value: "", type: "query" })
return false
},
removeRequestParam(index) {
// .slice() gives us an entirely new array rather than giving us just the reference
const oldParams = this.params.slice()
this.$store.commit("removeParams", index)
this.$toast.error(this.$t("deleted"), {
icon: "delete",
action: {
text: this.$t("undo"),
onClick: (e, toastObject) => {
this.params = oldParams
toastObject.remove()
},
},
})
},
addRequestBodyParam() {
this.$store.commit("addBodyParams", { key: "", value: "" })
return false
},
removeRequestBodyParam(index) {
// .slice() gives us an entirely new array rather than giving us just the reference
const oldBodyParams = this.bodyParams.slice()
this.$store.commit("removeBodyParams", index)
this.$toast.error(this.$t("deleted"), {
icon: "delete",
action: {
text: this.$t("undo"),
onClick: (e, toastObject) => {
this.bodyParams = oldBodyParams
toastObject.remove()
},
},
})
},
prettifyRequestBody() {
try {
const jsonObj = JSON.parse(this.rawParams)
this.rawParams = JSON.stringify(jsonObj, null, 2)
let oldIcon = this.$refs.prettifyRequest.innerHTML
this.$refs.prettifyRequest.innerHTML = this.doneButton
setTimeout(() => (this.$refs.prettifyRequest.innerHTML = oldIcon), 1000)
} catch (e) {
this.$toast.error(`${this.$t("json_prettify_invalid_body")}`, {
icon: "error",
})
}
},
copyRequest() {
if (navigator.share) {
const time = new Date().toLocaleTimeString()
const date = new Date().toLocaleDateString()
navigator
.share({
title: "Hoppscotch",
text: `Hoppscotch • API request builder at ${time} on ${date}`,
url: window.location.href,
})
.then(() => {})
.catch(() => {})
} else {
const dummy = document.createElement("input")
document.body.appendChild(dummy)
dummy.value = window.location.href
dummy.select()
document.execCommand("copy")
document.body.removeChild(dummy)
this.$refs.copyRequest.innerHTML = this.doneButton
this.$toast.info(this.$t("copied_to_clipboard"), {
icon: "done",
})
setTimeout(() => (this.$refs.copyRequest.innerHTML = this.copyButton), 1000)
}
},
setRouteQueryState() {
const flat = (key) => (this[key] !== "" ? `${key}=${this[key]}&` : "")
const deep = (key) => {
const haveItems = [...this[key]].length
if (haveItems && this[key]["value"] !== "") {
return `${key}=${JSON.stringify(this[key])}&`
}
return ""
}
let flats = [
"method",
"url",
"path",
!this.urlExcludes.auth ? "auth" : null,
!this.urlExcludes.httpUser ? "httpUser" : null,
!this.urlExcludes.httpPassword ? "httpPassword" : null,
!this.urlExcludes.bearerToken ? "bearerToken" : null,
"contentType",
]
.filter((item) => item !== null)
.map((item) => flat(item))
const deeps = ["headers", "params"].map((item) => deep(item))
const bodyParams = this.rawInput ? [flat("rawParams")] : [deep("bodyParams")]
history.replaceState(
window.location.href,
"",
`/?${encodeURI(flats.concat(deeps, bodyParams).join("").slice(0, -1))}`
)
},
setRouteQueries(queries) {
if (typeof queries !== "object") throw new Error("Route query parameters must be a Object")
for (const key in queries) {
if (["headers", "params", "bodyParams"].includes(key))
this[key] = JSON.parse(decodeURI(queries[key]))
if (key === "rawParams") {
this.rawInput = true
this.rawParams = queries["rawParams"]
} else if (typeof this[key] === "string") {
this[key] = queries[key]
}
}
},
observeRequestButton() {
const requestElement = this.$refs.request.$el
const sendButtonElement = this.$refs.sendButton
const observer = new IntersectionObserver(
(entries, observer) => {
entries.forEach(({ isIntersecting }) => {
if (isIntersecting) sendButtonElement.classList.remove("show")
// The button should float when it is no longer visible on screen.
// This is done by adding the show class to the button.
else sendButtonElement.classList.add("show")
})
},
{
rootMargin: "0px",
threshold: [0],
}
)
observer.observe(requestElement)
},
handleImport() {
const { value: text } = document.getElementById("import-curl")
try {
const parsedCurl = parseCurlCommand(text)
const { origin, pathname } = new URL(parsedCurl.url.replace(/"/g, "").replace(/'/g, ""))
this.url = origin
this.path = pathname
this.uri = this.url + this.path
this.headers = []
if (parsedCurl.headers) {
for (const key of Object.keys(parsedCurl.headers)) {
this.$store.commit("addHeaders", {
key,
value: parsedCurl.headers[key],
})
}
}
this.method = parsedCurl.method.toUpperCase()
if (parsedCurl["data"]) {
this.rawInput = true
this.rawParams = parsedCurl["data"]
}
this.showCurlImportModal = false
} catch (error) {
this.showCurlImportModal = false
this.$toast.error(this.$t("curl_invalid_format"), {
icon: "error",
})
}
},
switchVisibility() {
this.passwordFieldType = this.passwordFieldType === "password" ? "text" : "password"
},
clearContent(name, { target }) {
switch (name) {
case "bodyParams":
this.bodyParams = []
this.files = []
break
case "rawParams":
this.rawParams = "{}"
break
case "parameters":
this.params = []
break
case "auth":
this.auth = "None"
this.httpUser = ""
this.httpPassword = ""
this.bearerToken = ""
this.showTokenRequest = false
this.tokens = []
this.tokenReqs = []
break
case "access_token":
this.accessTokenName = ""
this.oidcDiscoveryUrl = ""
this.authUrl = ""
this.accessTokenUrl = ""
this.clientId = ""
this.scope = ""
break
case "headers":
this.headers = []
break
case "tests":
this.testReports = []
break
case "tokens":
this.tokens = []
break
default:
this.method = "GET"
this.url = "https://httpbin.org"
this.path = "/get"
this.uri = this.url + this.path
this.name = "Untitled request"
this.bodyParams = []
this.rawParams = "{}"
this.files = []
this.params = []
this.auth = "None"
this.httpUser = ""
this.httpPassword = ""
this.bearerToken = ""
this.showTokenRequest = false
this.tokens = []
this.tokenReqs = []
this.accessTokenName = ""
this.oidcDiscoveryUrl = ""
this.authUrl = ""
this.accessTokenUrl = ""
this.clientId = ""
this.scope = ""
this.headers = []
this.testReports = []
}
target.innerHTML = this.doneButton
this.$toast.info(this.$t("cleared"), {
icon: "clear_all",
})
setTimeout(() => (target.innerHTML = '<i class="material-icons">clear_all</i>'), 1000)
},
saveRequest() {
if (!this.checkCollections()) {
this.$toast.error(this.$t("create_collection"), {
icon: "error",
})
return
}
let urlAndPath = parseUrlAndPath(this.uri)
this.editRequest = {
url: urlAndPath.url,
path: urlAndPath.path,
method: this.method,
auth: this.auth,
httpUser: this.httpUser,
httpPassword: this.httpPassword,
passwordFieldType: this.passwordFieldType,
bearerToken: this.bearerToken,
headers: this.headers,
params: this.params,
bodyParams: this.bodyParams,
rawParams: this.rawParams,
rawInput: this.rawInput,
contentType: this.contentType,
requestType: this.requestType,
preRequestScript: this.showPreRequestScript == true ? this.preRequestScript : null,
testScript: this.testsEnabled == true ? this.testScript : null,
name: this.requestName,
}
if (this.selectedRequest.url) {
this.editRequest = Object.assign({}, this.selectedRequest, this.editRequest)
}
this.showSaveRequestModal = true
},
hideRequestModal() {
this.showSaveRequestModal = false
this.editRequest = {}
},
setExclude(excludedField, excluded) {
if (excludedField === "auth") {
this.urlExcludes.auth = excluded
this.urlExcludes.httpUser = excluded
this.urlExcludes.httpPassword = excluded
this.urlExcludes.bearerToken = excluded
} else {
this.urlExcludes[excludedField] = excluded
}
this.setRouteQueryState()
},
uploadAttachment() {
this.filenames = ""
this.files = this.$refs.attachment.files
if (this.files.length !== 0) {
for (let file of this.files) {
this.filenames = `${this.filenames}<br/>${file.name}`
}
this.$toast.info(this.$t("file_imported"), {
icon: "attach_file",
})
} else {
this.$toast.error(this.$t("choose_file"), {
icon: "attach_file",
})
}
},
uploadPayload() {
this.rawInput = true
const file = this.$refs.payload.files[0]
if (file !== undefined && file !== null) {
const reader = new FileReader()
reader.onload = ({ target }) => {
this.rawParams = target.result
}
reader.readAsText(file)
this.$toast.info(this.$t("file_imported"), {
icon: "attach_file",
})
} else {
this.$toast.error(this.$t("choose_file"), {
icon: "attach_file",
})
}
this.$refs.payload.value = ""
},
async handleAccessTokenRequest() {
if (this.oidcDiscoveryUrl === "" && (this.authUrl === "" || this.accessTokenUrl === "")) {
this.$toast.error(this.$t("complete_config_urls"), {
icon: "error",
})
return
}
try {
const tokenReqParams = {
grantType: "code",
oidcDiscoveryUrl: this.oidcDiscoveryUrl,
authUrl: this.authUrl,
accessTokenUrl: this.accessTokenUrl,
clientId: this.clientId,
scope: this.scope,
}
await tokenRequest(tokenReqParams)
} catch (e) {
this.$toast.error(e, {
icon: "code",
})
}
},
async oauthRedirectReq() {
const tokenInfo = await oauthRedirect()
if (Object.prototype.hasOwnProperty.call(tokenInfo, "access_token")) {
this.bearerToken = tokenInfo.access_token
this.addOAuthToken({
name: this.accessTokenName,
value: tokenInfo.access_token,
})
}
},
addOAuthToken({ name, value }) {
this.$store.commit("addOAuthToken", {
name,
value,
})
return false
},
removeOAuthToken(index) {
const oldTokens = this.tokens.slice()
this.$store.commit("removeOAuthToken", index)
this.$toast.error(this.$t("deleted"), {
icon: "delete",
action: {
text: this.$t("undo"),
onClick: (e, toastObject) => {
this.tokens = oldTokens
toastObject.remove()
},
},
})
},
useOAuthToken(value) {
this.bearerToken = value
this.showTokenListModal = false
},
addOAuthTokenReq() {
try {
const name = this.tokenReqName
const details = JSON.parse(this.tokenReqDetails)
this.$store.commit("addOAuthTokenReq", {
name,
details,
})
this.$toast.info(this.$t("token_request_saved"))
this.showTokenRequestList = false
} catch (e) {
this.$toast.error(e, {
icon: "code",
})
}
},
removeOAuthTokenReq(index) {
const oldTokenReqs = this.tokenReqs.slice()
const targetReqIndex = this.tokenReqs.findIndex(({ name }) => name === this.tokenReqName)
if (targetReqIndex < 0) return
this.$store.commit("removeOAuthTokenReq", targetReqIndex)
this.$toast.error(this.$t("deleted"), {
icon: "delete",
action: {
text: this.$t("undo"),
onClick: (e, toastObject) => {
this.tokenReqs = oldTokenReqs
toastObject.remove()
},
},
})
},
tokenReqChange({ target }) {
const { details, name } = this.tokenReqs.find(({ name }) => name === target.value)
const { oidcDiscoveryUrl, authUrl, accessTokenUrl, clientId, scope } = details
this.tokenReqName = name
this.oidcDiscoveryUrl = oidcDiscoveryUrl
this.authUrl = authUrl
this.accessTokenUrl = accessTokenUrl
this.clientId = clientId
this.scope = scope
},
setRequestType(val) {
this.requestType = val
},
},
async mounted() {
this.observeRequestButton()
this._keyListener = function (e) {
if (e.key === "g" && (e.ctrlKey || e.metaKey)) {
e.preventDefault()
if (!this.runningRequest) {
this.sendRequest()
} else {
this.cancelRequest()
}
}
if (e.key === "s" && (e.ctrlKey || e.metaKey)) {
e.preventDefault()
this.saveRequest()
}
if (e.key === "k" && (e.ctrlKey || e.metaKey)) {
e.preventDefault()
this.copyRequest()
}
if (e.key === "i" && (e.ctrlKey || e.metaKey)) {
e.preventDefault()
this.$refs.clearAll.click()
}
if (e.key === "Escape") {
e.preventDefault()
this.showCurlImportModal = this.showTokenListModal = this.showTokenRequestList = this.showSaveRequestModal = this.showCodegenModal = false
}
if ((e.key === "g" || e.key === "G") && e.altKey) {
this.method = "GET"
}
if ((e.key === "h" || e.key === "H") && e.altKey) {
this.method = "HEAD"
}
if ((e.key === "p" || e.key === "P") && e.altKey) {
this.method = "POST"
}
if ((e.key === "u" || e.key === "U") && e.altKey) {
this.method = "PUT"
}
if ((e.key === "x" || e.key === "X") && e.altKey) {
this.method = "DELETE"
}
if (e.key == "ArrowUp" && e.altKey && this.currentMethodIndex > 0) {
this.method = this.methodMenuItems[--this.currentMethodIndex % this.methodMenuItems.length]
} else if (e.key == "ArrowDown" && e.altKey && this.currentMethodIndex < 9) {
this.method = this.methodMenuItems[++this.currentMethodIndex % this.methodMenuItems.length]
}
}
document.addEventListener("keydown", this._keyListener.bind(this))
await this.oauthRedirectReq()
},
created() {
this.urlExcludes = this.$store.state.postwoman.settings.URL_EXCLUDES || {
// Exclude authentication by default for security reasons.
auth: true,
httpUser: true,
httpPassword: true,
bearerToken: true,
}
if (Object.keys(this.$route.query).length) this.setRouteQueries(this.$route.query)
this.$watch(
(vm) => [
vm.name,
vm.method,
vm.url,
vm.auth,
vm.path,
vm.httpUser,
vm.httpPassword,
vm.bearerToken,
vm.headers,
vm.params,
vm.bodyParams,
vm.contentType,
vm.rawParams,
],
(val) => {
this.setRouteQueryState()
}
)
},
beforeDestroy() {
document.removeEventListener("keydown", this._keyListener)
},
}
</script>