mirror of
https://github.com/Kong/insomnia
synced 2024-11-08 23:00:30 +00:00
dfc89a3111
Co-authored-by: Opender Singh <opender.singh@konghq.com>
113 lines
3.6 KiB
JavaScript
113 lines
3.6 KiB
JavaScript
const crypto = require('crypto');
|
|
|
|
module.exports.templateTags = [
|
|
{
|
|
displayName: 'Prompt',
|
|
name: 'prompt',
|
|
description: 'prompt user for input',
|
|
disablePreview: args => args[4] && args[4].value === true,
|
|
args: [
|
|
{
|
|
displayName: 'Title',
|
|
type: 'string',
|
|
help: 'Title is a unique string used to identify the prompt value',
|
|
validate: v => (v ? '' : 'Required'),
|
|
},
|
|
{
|
|
displayName: 'Label',
|
|
type: 'string',
|
|
},
|
|
{
|
|
displayName: 'Default Value',
|
|
type: 'string',
|
|
help:
|
|
'This value is used to pre-populate the prompt dialog, but is ALSO used ' +
|
|
'when the app renders preview values (like the one below). This is to prevent the ' +
|
|
'prompt from displaying too frequently during general app use.',
|
|
},
|
|
{
|
|
displayName: 'Storage Key',
|
|
type: 'string',
|
|
help:
|
|
'If this is set, the value will be stored in memory under this key until the app is ' +
|
|
"closed. To force this tag to re-prompt the user, simply change this key's value to " +
|
|
'something else.',
|
|
},
|
|
{
|
|
displayName: 'Mask Text',
|
|
type: 'boolean',
|
|
help: 'If this is enabled, the value when input will be masked like a password field.',
|
|
defaultValue: false,
|
|
},
|
|
{
|
|
displayName: 'Default to Last Value',
|
|
type: 'boolean',
|
|
help:
|
|
'If this is enabled, the input field will be pre-filled with this value. This option is ' +
|
|
'ignored when the storage key is set.',
|
|
defaultValue: true,
|
|
},
|
|
],
|
|
actions: [
|
|
{
|
|
name: 'Clear',
|
|
icon: 'fa fa-trash',
|
|
run: context => {
|
|
console.log(`[prompt] Clear action`);
|
|
return context.store.clear();
|
|
},
|
|
},
|
|
],
|
|
async run(context, title, label, defaultValue, explicitStorageKey, maskText, saveLastValue) {
|
|
if (!title) {
|
|
throw new Error('Title attribute is required for prompt tag');
|
|
}
|
|
|
|
// If we don't have a key, default to request ID.
|
|
// We do this because we may render the prompt multiple times per request.
|
|
// We cache it under the requestId so it only prompts once. We then clear
|
|
// the cache in a response hook when the request is sent.
|
|
const titleHash = crypto
|
|
.createHash('md5')
|
|
.update(title)
|
|
.digest('hex');
|
|
const storageKey = explicitStorageKey || `${context.meta.requestId}.${titleHash}`;
|
|
const cachedValue = await context.store.getItem(storageKey);
|
|
|
|
// Directly return cached value if using explicitly defined storage key
|
|
if (explicitStorageKey && cachedValue) {
|
|
console.log(`[prompt] Used cached value under ${storageKey}`);
|
|
return cachedValue;
|
|
}
|
|
|
|
// Use cached value as default value
|
|
if (cachedValue && saveLastValue) {
|
|
defaultValue = cachedValue;
|
|
console.log(`[prompt] Used cached value under ${storageKey}`);
|
|
}
|
|
|
|
// Only prompt when we're actually sending
|
|
if (context.renderPurpose !== 'send') {
|
|
if (cachedValue !== null) {
|
|
return cachedValue;
|
|
} else {
|
|
return defaultValue || '';
|
|
}
|
|
}
|
|
|
|
const value = await context.app.prompt(title || 'Enter Value', {
|
|
label,
|
|
defaultValue,
|
|
inputType: maskText ? 'password' : 'text',
|
|
});
|
|
|
|
if (storageKey) {
|
|
console.log(`[prompt] Stored value under ${storageKey}`);
|
|
await context.store.setItem(storageKey, value);
|
|
}
|
|
|
|
return value;
|
|
},
|
|
},
|
|
];
|